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.
7 * This file is part of the SCTP kernel reference Implementation
9 * The SCTP reference implementation is free software;
10 * you can redistribute it and/or modify it under the terms of
11 * the GNU General Public License as published by
12 * the Free Software Foundation; either version 2, or (at your option)
15 * The SCTP reference implementation is distributed in the hope that it
16 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
17 * ************************
18 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19 * See the GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with GNU CC; see the file COPYING. If not, write to
23 * the Free Software Foundation, 59 Temple Place - Suite 330,
24 * Boston, MA 02111-1307, USA.
26 * Please send any bug reports or fixes you make to the
28 * lksctp developers <lksctp-developers@lists.sourceforge.net>
30 * Or submit a bug report through the following website:
31 * http://www.sf.net/projects/lksctp
33 * Written or modified by:
34 * Randall Stewart <randall@sctp.chicago.il.us>
35 * Ken Morneau <kmorneau@cisco.com>
36 * Qiaobing Xie <qxie1@email.mot.com>
37 * La Monte H.P. Yarroll <piggy@acm.org>
38 * Karl Knutson <karl@athena.chicago.il.us>
39 * Jon Grimm <jgrimm@us.ibm.com>
40 * Xingang Guo <xingang.guo@intel.com>
41 * Hui Huang <hui.huang@nokia.com>
42 * Sridhar Samudrala <sri@us.ibm.com>
43 * Daisy Chang <daisyc@us.ibm.com>
44 * Dajiang Zhang <dajiang.zhang@nokia.com>
45 * Ardelle Fan <ardelle.fan@intel.com>
46 * Ryan Layer <rmlayer@us.ibm.com>
47 * Anup Pemmaiah <pemmaiah@cc.usu.edu>
48 * Kevin Gao <kevin.gao@intel.com>
50 * Any bugs reported given to us we will try to fix... any fixes shared will
51 * be incorporated into the next SCTP release.
54 #ifndef __sctp_structs_h__
55 #define __sctp_structs_h__
57 #include <linux/time.h> /* We get struct timespec. */
58 #include <linux/socket.h> /* linux/in.h needs this!! */
59 #include <linux/in.h> /* We get struct sockaddr_in. */
60 #include <linux/in6.h> /* We get struct in6_addr */
61 #include <linux/ipv6.h>
62 #include <asm/param.h> /* We get MAXHOSTNAMELEN. */
63 #include <asm/atomic.h> /* This gets us atomic counters. */
64 #include <linux/skbuff.h> /* We need sk_buff_head. */
65 #include <linux/workqueue.h> /* We need tq_struct. */
66 #include <linux/sctp.h> /* We need sctp* header structs. */
67 #include <net/sctp/auth.h> /* We need auth specific structs */
69 /* A convenience structure for handling sockaddr structures.
70 * We should wean ourselves off this.
73 struct sockaddr_in v4;
74 struct sockaddr_in6 v6;
78 /* Forward declarations for data structures. */
81 struct sctp_association;
82 struct sctp_transport;
87 struct sctp_bind_addr;
89 struct sctp_ep_common;
94 #include <net/sctp/tsnmap.h>
95 #include <net/sctp/ulpevent.h>
96 #include <net/sctp/ulpqueue.h>
98 /* Structures useful for managing bind/connect. */
100 struct sctp_bind_bucket {
102 unsigned short fastreuse;
103 struct sctp_bind_bucket *next;
104 struct sctp_bind_bucket **pprev;
105 struct hlist_head owner;
108 struct sctp_bind_hashbucket {
110 struct sctp_bind_bucket *chain;
113 /* Used for hashing all associations. */
114 struct sctp_hashbucket {
116 struct sctp_ep_common *chain;
117 } __attribute__((__aligned__(8)));
120 /* The SCTP globals structure. */
121 extern struct sctp_globals {
122 /* RFC2960 Section 14. Suggested SCTP Protocol Parameter Values
124 * The following protocol parameters are RECOMMENDED:
126 * RTO.Initial - 3 seconds
128 * RTO.Max - 60 seconds
129 * RTO.Alpha - 1/8 (3 when converted to right shifts.)
130 * RTO.Beta - 1/4 (2 when converted to right shifts.)
132 unsigned int rto_initial;
133 unsigned int rto_min;
134 unsigned int rto_max;
136 /* Note: rto_alpha and rto_beta are really defined as inverse
137 * powers of two to facilitate integer operations.
145 /* Whether Cookie Preservative is enabled(1) or not(0) */
146 int cookie_preserve_enable;
148 /* Valid.Cookie.Life - 60 seconds */
149 unsigned int valid_cookie_life;
151 /* Delayed SACK timeout 200ms default*/
152 unsigned int sack_timeout;
154 /* HB.interval - 30 seconds */
155 unsigned int hb_interval;
157 /* Association.Max.Retrans - 10 attempts
158 * Path.Max.Retrans - 5 attempts (per destination address)
159 * Max.Init.Retransmits - 8 attempts
161 int max_retrans_association;
162 int max_retrans_path;
163 int max_retrans_init;
166 * Policy for preforming sctp/socket accounting
167 * 0 - do socket level accounting, all assocs share sk_sndbuf
168 * 1 - do sctp accounting, each asoc may use sk_sndbuf bytes
173 * Policy for preforming sctp/socket accounting
174 * 0 - do socket level accounting, all assocs share sk_rcvbuf
175 * 1 - do sctp accounting, each asoc may use sk_rcvbuf bytes
179 /* The following variables are implementation specific. */
181 /* Default initialization values to be applied to new associations. */
183 __u16 max_outstreams;
185 /* This is a list of groups of functions for each address
186 * family that we support.
188 struct list_head address_families;
190 /* This is the hash of all endpoints. */
192 struct sctp_hashbucket *ep_hashtable;
194 /* This is the hash of all associations. */
196 struct sctp_hashbucket *assoc_hashtable;
198 /* This is the sctp port control hash. */
200 struct sctp_bind_hashbucket *port_hashtable;
202 /* This is the global local address list.
203 * We actively maintain this complete list of addresses on
204 * the system by catching address add/delete events.
206 * It is a list of sctp_sockaddr_entry.
208 struct list_head local_addr_list;
210 /* Lock that protects the local_addr_list writers */
211 spinlock_t addr_list_lock;
213 /* Flag to indicate if addip is enabled. */
216 /* Flag to indicate if PR-SCTP is enabled. */
219 /* Flag to idicate if SCTP-AUTH is enabled */
223 #define sctp_rto_initial (sctp_globals.rto_initial)
224 #define sctp_rto_min (sctp_globals.rto_min)
225 #define sctp_rto_max (sctp_globals.rto_max)
226 #define sctp_rto_alpha (sctp_globals.rto_alpha)
227 #define sctp_rto_beta (sctp_globals.rto_beta)
228 #define sctp_max_burst (sctp_globals.max_burst)
229 #define sctp_valid_cookie_life (sctp_globals.valid_cookie_life)
230 #define sctp_cookie_preserve_enable (sctp_globals.cookie_preserve_enable)
231 #define sctp_max_retrans_association (sctp_globals.max_retrans_association)
232 #define sctp_sndbuf_policy (sctp_globals.sndbuf_policy)
233 #define sctp_rcvbuf_policy (sctp_globals.rcvbuf_policy)
234 #define sctp_max_retrans_path (sctp_globals.max_retrans_path)
235 #define sctp_max_retrans_init (sctp_globals.max_retrans_init)
236 #define sctp_sack_timeout (sctp_globals.sack_timeout)
237 #define sctp_hb_interval (sctp_globals.hb_interval)
238 #define sctp_max_instreams (sctp_globals.max_instreams)
239 #define sctp_max_outstreams (sctp_globals.max_outstreams)
240 #define sctp_address_families (sctp_globals.address_families)
241 #define sctp_ep_hashsize (sctp_globals.ep_hashsize)
242 #define sctp_ep_hashtable (sctp_globals.ep_hashtable)
243 #define sctp_assoc_hashsize (sctp_globals.assoc_hashsize)
244 #define sctp_assoc_hashtable (sctp_globals.assoc_hashtable)
245 #define sctp_port_hashsize (sctp_globals.port_hashsize)
246 #define sctp_port_rover (sctp_globals.port_rover)
247 #define sctp_port_alloc_lock (sctp_globals.port_alloc_lock)
248 #define sctp_port_hashtable (sctp_globals.port_hashtable)
249 #define sctp_local_addr_list (sctp_globals.local_addr_list)
250 #define sctp_local_addr_lock (sctp_globals.addr_list_lock)
251 #define sctp_addip_enable (sctp_globals.addip_enable)
252 #define sctp_prsctp_enable (sctp_globals.prsctp_enable)
253 #define sctp_auth_enable (sctp_globals.auth_enable)
255 /* SCTP Socket type: UDP or TCP style. */
258 SCTP_SOCKET_UDP_HIGH_BANDWIDTH,
260 } sctp_socket_type_t;
262 /* Per socket SCTP information. */
264 /* inet_sock has to be the first member of sctp_sock */
265 struct inet_sock inet;
266 /* What kind of a socket is this? */
267 sctp_socket_type_t type;
269 /* PF_ family specific functions. */
272 /* Access to HMAC transform. */
273 struct crypto_hash *hmac;
275 /* What is our base endpointer? */
276 struct sctp_endpoint *ep;
278 struct sctp_bind_bucket *bind_hash;
279 /* Various Socket Options. */
280 __u16 default_stream;
283 __u32 default_context;
284 __u32 default_timetolive;
285 __u32 default_rcv_context;
288 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
289 * the destination address every heartbeat interval. This value
290 * will be inherited by all new associations.
294 /* This is the max_retrans value for new associations. */
297 /* The initial Path MTU to use for new associations. */
300 /* The default SACK delay timeout for new associations. */
303 /* Flags controling Heartbeat, SACK delay, and Path MTU Discovery. */
306 struct sctp_initmsg initmsg;
307 struct sctp_rtoinfo rtoinfo;
308 struct sctp_paddrparams paddrparam;
309 struct sctp_event_subscribe subscribe;
310 struct sctp_assocparams assocparams;
314 __u8 disable_fragments;
316 __u8 frag_interleave;
317 __u32 adaptation_ind;
321 /* Receive to here while partial delivery is in effect. */
322 struct sk_buff_head pd_lobby;
325 static inline struct sctp_sock *sctp_sk(const struct sock *sk)
327 return (struct sctp_sock *)sk;
330 static inline struct sock *sctp_opt2sk(const struct sctp_sock *sp)
332 return (struct sock *)sp;
335 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
337 struct sctp_sock sctp;
338 struct ipv6_pinfo inet6;
340 #endif /* CONFIG_IPV6 */
343 /* This is our APPLICATION-SPECIFIC state cookie.
344 * THIS IS NOT DICTATED BY THE SPECIFICATION.
346 /* These are the parts of an association which we send in the cookie.
347 * Most of these are straight out of:
348 * RFC2960 12.2 Parameters necessary per association (i.e. the TCB)
354 /* My : Tag expected in every inbound packet and sent
355 * Verification: in the INIT or INIT ACK chunk.
360 /* Peer's : Tag expected in every outbound packet except
361 * Verification: in the INIT chunk.
366 /* The rest of these are not from the spec, but really need to
370 /* My Tie Tag : Assist in discovering a restarting association. */
373 /* Peer's Tie Tag: Assist in discovering a restarting association. */
376 /* When does this cookie expire? */
377 struct timeval expiration;
379 /* Number of inbound/outbound streams which are set
380 * and negotiated during the INIT process.
382 __u16 sinit_num_ostreams;
383 __u16 sinit_max_instreams;
385 /* This is the first sequence number I used. */
388 /* This holds the originating address of the INIT packet. */
389 union sctp_addr peer_addr;
392 * Include the source port of the INIT-ACK
398 /* Padding for future use */
401 __u32 adaptation_ind;
403 __u8 auth_random[sizeof(sctp_paramhdr_t) + SCTP_AUTH_RANDOM_LENGTH];
404 __u8 auth_hmacs[SCTP_AUTH_NUM_HMACS + 2];
405 __u8 auth_chunks[sizeof(sctp_paramhdr_t) + SCTP_AUTH_MAX_CHUNKS];
407 /* This is a shim for my peer's INIT packet, followed by
408 * a copy of the raw address list of the association.
409 * The length of the raw address list is saved in the
410 * raw_addr_list_len field, which will be used at the time when
411 * the association TCB is re-constructed from the cookie.
413 __u32 raw_addr_list_len;
414 struct sctp_init_chunk peer_init[0];
418 /* The format of our cookie that we send to our peer. */
419 struct sctp_signed_cookie {
420 __u8 signature[SCTP_SECRET_SIZE];
421 __u32 __pad; /* force sctp_cookie alignment to 64 bits */
422 struct sctp_cookie c;
423 } __attribute__((packed));
425 /* This is another convenience type to allocate memory for address
426 * params for the maximum size and pass such structures around
429 union sctp_addr_param {
430 struct sctp_paramhdr p;
431 struct sctp_ipv4addr_param v4;
432 struct sctp_ipv6addr_param v6;
435 /* A convenience type to allow walking through the various
436 * parameters and avoid casting all over the place.
440 struct sctp_paramhdr *p;
441 struct sctp_cookie_preserve_param *life;
442 struct sctp_hostname_param *dns;
443 struct sctp_cookie_param *cookie;
444 struct sctp_supported_addrs_param *sat;
445 struct sctp_ipv4addr_param *v4;
446 struct sctp_ipv6addr_param *v6;
447 union sctp_addr_param *addr;
448 struct sctp_adaptation_ind_param *aind;
449 struct sctp_supported_ext_param *ext;
450 struct sctp_random_param *random;
451 struct sctp_chunks_param *chunks;
452 struct sctp_hmac_algo_param *hmac_algo;
455 /* RFC 2960. Section 3.3.5 Heartbeat.
456 * Heartbeat Information: variable length
457 * The Sender-specific Heartbeat Info field should normally include
458 * information about the sender's current time when this HEARTBEAT
459 * chunk is sent and the destination transport address to which this
460 * HEARTBEAT is sent (see Section 8.3).
462 typedef struct sctp_sender_hb_info {
463 struct sctp_paramhdr param_hdr;
464 union sctp_addr daddr;
465 unsigned long sent_at;
467 } __attribute__((packed)) sctp_sender_hb_info_t;
470 * RFC 2960 1.3.2 Sequenced Delivery within Streams
472 * The term "stream" is used in SCTP to refer to a sequence of user
473 * messages that are to be delivered to the upper-layer protocol in
474 * order with respect to other messages within the same stream. This is
475 * in contrast to its usage in TCP, where it refers to a sequence of
476 * bytes (in this document a byte is assumed to be eight bits).
479 * This is the structure we use to track both our outbound and inbound
480 * SSN, or Stream Sequence Numbers.
489 struct sctp_stream in;
490 struct sctp_stream out;
494 struct sctp_ssnmap *sctp_ssnmap_new(__u16 in, __u16 out,
496 void sctp_ssnmap_free(struct sctp_ssnmap *map);
497 void sctp_ssnmap_clear(struct sctp_ssnmap *map);
499 /* What is the current SSN number for this stream? */
500 static inline __u16 sctp_ssn_peek(struct sctp_stream *stream, __u16 id)
502 return stream->ssn[id];
505 /* Return the next SSN number for this stream. */
506 static inline __u16 sctp_ssn_next(struct sctp_stream *stream, __u16 id)
508 return stream->ssn[id]++;
511 /* Skip over this ssn and all below. */
512 static inline void sctp_ssn_skip(struct sctp_stream *stream, __u16 id,
515 stream->ssn[id] = ssn+1;
519 * Pointers to address related SCTP functions.
520 * (i.e. things that depend on the address family.)
523 int (*sctp_xmit) (struct sk_buff *skb,
524 struct sctp_transport *,
526 int (*setsockopt) (struct sock *sk,
531 int (*getsockopt) (struct sock *sk,
536 int (*compat_setsockopt) (struct sock *sk,
541 int (*compat_getsockopt) (struct sock *sk,
546 struct dst_entry *(*get_dst) (struct sctp_association *asoc,
547 union sctp_addr *daddr,
548 union sctp_addr *saddr);
549 void (*get_saddr) (struct sctp_association *asoc,
550 struct dst_entry *dst,
551 union sctp_addr *daddr,
552 union sctp_addr *saddr);
553 void (*copy_addrlist) (struct list_head *,
554 struct net_device *);
555 void (*dst_saddr) (union sctp_addr *saddr,
556 struct dst_entry *dst,
558 int (*cmp_addr) (const union sctp_addr *addr1,
559 const union sctp_addr *addr2);
560 void (*addr_copy) (union sctp_addr *dst,
561 union sctp_addr *src);
562 void (*from_skb) (union sctp_addr *,
565 void (*from_sk) (union sctp_addr *,
567 void (*to_sk_saddr) (union sctp_addr *,
569 void (*to_sk_daddr) (union sctp_addr *,
571 void (*from_addr_param) (union sctp_addr *,
572 union sctp_addr_param *,
573 __be16 port, int iif);
574 int (*to_addr_param) (const union sctp_addr *,
575 union sctp_addr_param *);
576 int (*addr_valid) (union sctp_addr *,
578 const struct sk_buff *);
579 sctp_scope_t (*scope) (union sctp_addr *);
580 void (*inaddr_any) (union sctp_addr *, __be16);
581 int (*is_any) (const union sctp_addr *);
582 int (*available) (union sctp_addr *,
584 int (*skb_iif) (const struct sk_buff *sk);
585 int (*is_ce) (const struct sk_buff *sk);
586 void (*seq_dump_addr)(struct seq_file *seq,
587 union sctp_addr *addr);
588 __u16 net_header_len;
590 sa_family_t sa_family;
591 struct list_head list;
594 struct sctp_af *sctp_get_af_specific(sa_family_t);
595 int sctp_register_af(struct sctp_af *);
597 /* Protocol family functions. */
599 void (*event_msgname)(struct sctp_ulpevent *, char *, int *);
600 void (*skb_msgname) (struct sk_buff *, char *, int *);
601 int (*af_supported) (sa_family_t, struct sctp_sock *);
602 int (*cmp_addr) (const union sctp_addr *,
603 const union sctp_addr *,
605 int (*bind_verify) (struct sctp_sock *, union sctp_addr *);
606 int (*send_verify) (struct sctp_sock *, union sctp_addr *);
607 int (*supported_addrs)(const struct sctp_sock *, __be16 *);
608 struct sock *(*create_accept_sk) (struct sock *sk,
609 struct sctp_association *asoc);
610 void (*addr_v4map) (struct sctp_sock *, union sctp_addr *);
615 /* Structure to track chunk fragments that have been acked, but peer
616 * fragments of the same message have not.
618 struct sctp_datamsg {
619 /* Chunks waiting to be submitted to lower layer. */
620 struct list_head chunks;
621 /* Chunks that have been transmitted. */
622 struct list_head track;
623 /* Reference counting. */
625 /* When is this message no longer interesting to the peer? */
626 unsigned long expires_at;
627 /* Did the messenge fail to send? */
630 /* Control whether chunks from this message can be abandoned. */
634 struct sctp_datamsg *sctp_datamsg_from_user(struct sctp_association *,
635 struct sctp_sndrcvinfo *,
636 struct msghdr *, int len);
637 void sctp_datamsg_put(struct sctp_datamsg *);
638 void sctp_datamsg_free(struct sctp_datamsg *);
639 void sctp_datamsg_track(struct sctp_chunk *);
640 void sctp_chunk_fail(struct sctp_chunk *, int error);
641 int sctp_chunk_abandoned(struct sctp_chunk *);
643 /* RFC2960 1.4 Key Terms
645 * o Chunk: A unit of information within an SCTP packet, consisting of
646 * a chunk header and chunk-specific content.
648 * As a matter of convenience, we remember the SCTP common header for
649 * each chunk as well as a few other header pointers...
652 struct list_head list;
656 /* This is our link to the per-transport transmitted list. */
657 struct list_head transmitted_list;
659 /* This field is used by chunks that hold fragmented data.
660 * For the first fragment this is the list that holds the rest of
661 * fragments. For the remaining fragments, this is the link to the
662 * frag_list maintained in the first fragment.
664 struct list_head frag_list;
666 /* This points to the sk_buff containing the actual data. */
669 /* These are the SCTP headers by reverse order in a packet.
670 * Note that some of these may happen more than once. In that
671 * case, we point at the "current" one, whatever that means
672 * for that level of header.
675 /* We point this at the FIRST TLV parameter to chunk_hdr. */
676 union sctp_params param_hdr;
679 struct sctp_datahdr *data_hdr;
680 struct sctp_inithdr *init_hdr;
681 struct sctp_sackhdr *sack_hdr;
682 struct sctp_heartbeathdr *hb_hdr;
683 struct sctp_sender_hb_info *hbs_hdr;
684 struct sctp_shutdownhdr *shutdown_hdr;
685 struct sctp_signed_cookie *cookie_hdr;
686 struct sctp_ecnehdr *ecne_hdr;
687 struct sctp_cwrhdr *ecn_cwr_hdr;
688 struct sctp_errhdr *err_hdr;
689 struct sctp_addiphdr *addip_hdr;
690 struct sctp_fwdtsn_hdr *fwdtsn_hdr;
691 struct sctp_authhdr *auth_hdr;
696 struct sctp_chunkhdr *chunk_hdr;
697 struct sctphdr *sctp_hdr;
699 /* This needs to be recoverable for SCTP_SEND_FAILED events. */
700 struct sctp_sndrcvinfo sinfo;
702 /* Which association does this belong to? */
703 struct sctp_association *asoc;
705 /* What endpoint received this chunk? */
706 struct sctp_ep_common *rcvr;
708 /* We fill this in if we are calculating RTT. */
709 unsigned long sent_at;
711 /* What is the origin IP address for this chunk? */
712 union sctp_addr source;
713 /* Destination address for this chunk. */
714 union sctp_addr dest;
716 /* For outbound message, track all fragments for SEND_FAILED. */
717 struct sctp_datamsg *msg;
719 /* For an inbound chunk, this tells us where it came from.
720 * For an outbound chunk, it tells us where we'd like it to
721 * go. It is NULL if we have no preference.
723 struct sctp_transport *transport;
725 /* SCTP-AUTH: For the special case inbound processing of COOKIE-ECHO
726 * we need save a pointer to the AUTH chunk, since the SCTP-AUTH
727 * spec violates the principle premis that all chunks are processed
730 struct sk_buff *auth_chunk;
732 __u8 rtt_in_progress; /* Is this chunk used for RTT calculation? */
733 __u8 resent; /* Has this chunk ever been retransmitted. */
734 __u8 has_tsn; /* Does this chunk have a TSN yet? */
735 __u8 has_ssn; /* Does this chunk have a SSN yet? */
736 __u8 singleton; /* Was this the only chunk in the packet? */
737 __u8 end_of_packet; /* Was this the last chunk in the packet? */
738 __u8 ecn_ce_done; /* Have we processed the ECN CE bit? */
739 __u8 pdiscard; /* Discard the whole packet now? */
740 __u8 tsn_gap_acked; /* Is this chunk acked by a GAP ACK? */
741 __s8 fast_retransmit; /* Is this chunk fast retransmitted? */
742 __u8 tsn_missing_report; /* Data chunk missing counter. */
743 __u8 data_accepted; /* At least 1 chunk in this packet accepted */
744 __u8 auth; /* IN: was auth'ed | OUT: needs auth */
747 void sctp_chunk_hold(struct sctp_chunk *);
748 void sctp_chunk_put(struct sctp_chunk *);
749 int sctp_user_addto_chunk(struct sctp_chunk *chunk, int off, int len,
751 void sctp_chunk_free(struct sctp_chunk *);
752 void *sctp_addto_chunk(struct sctp_chunk *, int len, const void *data);
753 struct sctp_chunk *sctp_chunkify(struct sk_buff *,
754 const struct sctp_association *,
756 void sctp_init_addrs(struct sctp_chunk *, union sctp_addr *,
758 const union sctp_addr *sctp_source(const struct sctp_chunk *chunk);
760 /* This is a structure for holding either an IPv6 or an IPv4 address. */
761 struct sctp_sockaddr_entry {
762 struct list_head list;
769 typedef struct sctp_chunk *(sctp_packet_phandler_t)(struct sctp_association *);
771 /* This structure holds lists of chunks as we are assembling for
775 /* These are the SCTP header values (host order) for the packet. */
777 __u16 destination_port;
780 /* This contains the payload chunks. */
781 struct list_head chunk_list;
783 /* This is the overhead of the sctp and ip headers. */
785 /* This is the total size of all chunks INCLUDING padding. */
788 /* The packet is destined for this transport address.
789 * The function we finally use to pass down to the next lower
790 * layer lives in the transport structure.
792 struct sctp_transport *transport;
794 /* pointer to the auth chunk for this packet */
795 struct sctp_chunk *auth;
797 /* This packet contains a COOKIE-ECHO chunk. */
798 __u8 has_cookie_echo;
800 /* This packet contains a SACK chunk. */
803 /* This packet contains an AUTH chunk */
806 /* This packet contains at least 1 DATA chunk */
809 /* SCTP cannot fragment this packet. So let ip fragment it. */
815 struct sctp_packet *sctp_packet_init(struct sctp_packet *,
816 struct sctp_transport *,
817 __u16 sport, __u16 dport);
818 struct sctp_packet *sctp_packet_config(struct sctp_packet *, __u32 vtag, int);
819 sctp_xmit_t sctp_packet_transmit_chunk(struct sctp_packet *,
820 struct sctp_chunk *);
821 sctp_xmit_t sctp_packet_append_chunk(struct sctp_packet *,
822 struct sctp_chunk *);
823 int sctp_packet_transmit(struct sctp_packet *);
824 void sctp_packet_free(struct sctp_packet *);
826 static inline int sctp_packet_empty(struct sctp_packet *packet)
828 return (packet->size == packet->overhead);
831 /* This represents a remote transport address.
832 * For local transport addresses, we just use union sctp_addr.
834 * RFC2960 Section 1.4 Key Terms
836 * o Transport address: A Transport Address is traditionally defined
837 * by Network Layer address, Transport Layer protocol and Transport
838 * Layer port number. In the case of SCTP running over IP, a
839 * transport address is defined by the combination of an IP address
840 * and an SCTP port number (where SCTP is the Transport protocol).
842 * RFC2960 Section 7.1 SCTP Differences from TCP Congestion control
844 * o The sender keeps a separate congestion control parameter set for
845 * each of the destination addresses it can send to (not each
846 * source-destination pair but for each destination). The parameters
847 * should decay if the address is not used for a long enough time
851 struct sctp_transport {
852 /* A list of transports. */
853 struct list_head transports;
855 /* Reference counting. */
859 /* This is the peer's IP address and port. */
860 union sctp_addr ipaddr;
862 /* These are the functions we call to handle LLP stuff. */
863 struct sctp_af *af_specific;
865 /* Which association do we belong to? */
866 struct sctp_association *asoc;
870 * 12.3 Per Transport Address Data
872 * For each destination transport address in the peer's
873 * address list derived from the INIT or INIT ACK chunk, a
874 * number of data elements needs to be maintained including:
876 /* RTO : The current retransmission timeout value. */
878 unsigned long last_rto;
880 __u32 rtt; /* This is the most recent RTT. */
882 /* RTTVAR : The current RTT variation. */
885 /* SRTT : The current smoothed round trip time. */
888 /* RTO-Pending : A flag used to track if one of the DATA
889 * chunks sent to this address is currently being
890 * used to compute a RTT. If this flag is 0,
891 * the next DATA chunk sent to this destination
892 * should be used to compute a RTT and this flag
893 * should be set. Every time the RTT
894 * calculation completes (i.e. the DATA chunk
895 * is SACK'd) clear this flag.
900 * These are the congestion stats.
902 /* cwnd : The current congestion window. */
903 __u32 cwnd; /* This is the actual cwnd. */
905 /* ssthresh : The current slow start threshold value. */
908 /* partial : The tracking method for increase of cwnd when in
909 * bytes acked : congestion avoidance mode (see Section 6.2.2)
911 __u32 partial_bytes_acked;
913 /* Data that has been sent, but not acknowledged. */
917 struct dst_entry *dst;
918 /* Source address. */
919 union sctp_addr saddr;
921 /* When was the last time(in jiffies) that a data packet was sent on
922 * this transport? This is used to adjust the cwnd when the transport
925 unsigned long last_time_used;
927 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
928 * the destination address every heartbeat interval.
930 unsigned long hbinterval;
932 /* SACK delay timeout */
933 unsigned long sackdelay;
935 /* When was the last time (in jiffies) that we heard from this
936 * transport? We use this to pick new active and retran paths.
938 unsigned long last_time_heard;
940 /* Last time(in jiffies) when cwnd is reduced due to the congestion
941 * indication based on ECNE chunk.
943 unsigned long last_time_ecne_reduced;
945 /* This is the max_retrans value for the transport and will
946 * be initialized from the assocs value. This can be changed
947 * using SCTP_SET_PEER_ADDR_PARAMS socket option.
951 /* is the Path MTU update pending on this tranport */
954 /* PMTU : The current known path MTU. */
957 /* Flags controling Heartbeat, SACK delay, and Path MTU Discovery. */
960 /* The number of times INIT has been sent on this transport. */
963 /* state : The current state of this destination,
964 * : i.e. SCTP_ACTIVE, SCTP_INACTIVE, SCTP_UNKOWN.
968 /* These are the error stats for this destination. */
970 /* Error count : The current error count for this destination. */
971 unsigned short error_count;
973 /* Per : A timer used by each destination.
977 * [Everywhere else in the text this is called T3-rtx. -ed]
979 struct timer_list T3_rtx_timer;
981 /* Heartbeat timer is per destination. */
982 struct timer_list hb_timer;
984 /* Since we're using per-destination retransmission timers
985 * (see above), we're also using per-destination "transmitted"
986 * queues. This probably ought to be a private struct
987 * accessible only within the outqueue, but it's not, yet.
989 struct list_head transmitted;
991 /* We build bundle-able packets for this transport here. */
992 struct sctp_packet packet;
994 /* This is the list of transports that have chunks to send. */
995 struct list_head send_ready;
997 int malloced; /* Is this structure kfree()able? */
999 /* State information saved for SFR_CACC algorithm. The key
1000 * idea in SFR_CACC is to maintain state at the sender on a
1001 * per-destination basis when a changeover happens.
1002 * char changeover_active;
1003 * char cycling_changeover;
1004 * __u32 next_tsn_at_change;
1005 * char cacc_saw_newack;
1008 /* An unsigned integer, which stores the next TSN to be
1009 * used by the sender, at the moment of changeover.
1011 __u32 next_tsn_at_change;
1013 /* A flag which indicates the occurrence of a changeover */
1014 char changeover_active;
1016 /* A flag which indicates whether the change of primary is
1017 * the first switch to this destination address during an
1020 char cycling_changeover;
1022 /* A temporary flag, which is used during the processing of
1023 * a SACK to estimate the causative TSN(s)'s group.
1025 char cacc_saw_newack;
1028 /* 64-bit random number sent with heartbeat. */
1032 struct sctp_transport *sctp_transport_new(const union sctp_addr *,
1034 void sctp_transport_set_owner(struct sctp_transport *,
1035 struct sctp_association *);
1036 void sctp_transport_route(struct sctp_transport *, union sctp_addr *,
1037 struct sctp_sock *);
1038 void sctp_transport_pmtu(struct sctp_transport *);
1039 void sctp_transport_free(struct sctp_transport *);
1040 void sctp_transport_reset_timers(struct sctp_transport *);
1041 void sctp_transport_hold(struct sctp_transport *);
1042 void sctp_transport_put(struct sctp_transport *);
1043 void sctp_transport_update_rto(struct sctp_transport *, __u32);
1044 void sctp_transport_raise_cwnd(struct sctp_transport *, __u32, __u32);
1045 void sctp_transport_lower_cwnd(struct sctp_transport *, sctp_lower_cwnd_t);
1046 unsigned long sctp_transport_timeout(struct sctp_transport *);
1047 void sctp_transport_reset(struct sctp_transport *);
1048 void sctp_transport_update_pmtu(struct sctp_transport *, u32);
1051 /* This is the structure we use to queue packets as they come into
1052 * SCTP. We write packets to it and read chunks from it.
1055 /* This is actually a queue of sctp_chunk each
1056 * containing a partially decoded packet.
1058 struct list_head in_chunk_list;
1059 /* This is the packet which is currently off the in queue and is
1060 * being worked on through the inbound chunk processing.
1062 struct sctp_chunk *in_progress;
1064 /* This is the delayed task to finish delivering inbound
1067 struct work_struct immediate;
1069 int malloced; /* Is this structure kfree()able? */
1072 void sctp_inq_init(struct sctp_inq *);
1073 void sctp_inq_free(struct sctp_inq *);
1074 void sctp_inq_push(struct sctp_inq *, struct sctp_chunk *packet);
1075 struct sctp_chunk *sctp_inq_pop(struct sctp_inq *);
1076 struct sctp_chunkhdr *sctp_inq_peek(struct sctp_inq *);
1077 void sctp_inq_set_th_handler(struct sctp_inq *, work_func_t);
1079 /* This is the structure we use to hold outbound chunks. You push
1080 * chunks in and they automatically pop out the other end as bundled
1081 * packets (it calls (*output_handler)()).
1083 * This structure covers sections 6.3, 6.4, 6.7, 6.8, 6.10, 7., 8.1,
1084 * and 8.2 of the v13 draft.
1086 * It handles retransmissions. The connection to the timeout portion
1087 * of the state machine is through sctp_..._timeout() and timeout_handler.
1089 * If you feed it SACKs, it will eat them.
1091 * If you give it big chunks, it will fragment them.
1093 * It assigns TSN's to data chunks. This happens at the last possible
1094 * instant before transmission.
1096 * When free()'d, it empties itself out via output_handler().
1099 struct sctp_association *asoc;
1101 /* Data pending that has never been transmitted. */
1102 struct list_head out_chunk_list;
1104 unsigned out_qlen; /* Total length of queued data chunks. */
1106 /* Error of send failed, may used in SCTP_SEND_FAILED event. */
1109 /* These are control chunks we want to send. */
1110 struct list_head control_chunk_list;
1112 /* These are chunks that have been sacked but are above the
1113 * CTSN, or cumulative tsn ack point.
1115 struct list_head sacked;
1117 /* Put chunks on this list to schedule them for
1120 struct list_head retransmit;
1122 /* Put chunks on this list to save them for FWD TSN processing as
1123 * they were abandoned.
1125 struct list_head abandoned;
1127 /* How many unackd bytes do we have in-flight? */
1128 __u32 outstanding_bytes;
1133 /* Is this structure empty? */
1136 /* Are we kfree()able? */
1140 void sctp_outq_init(struct sctp_association *, struct sctp_outq *);
1141 void sctp_outq_teardown(struct sctp_outq *);
1142 void sctp_outq_free(struct sctp_outq*);
1143 int sctp_outq_tail(struct sctp_outq *, struct sctp_chunk *chunk);
1144 int sctp_outq_flush(struct sctp_outq *, int);
1145 int sctp_outq_sack(struct sctp_outq *, struct sctp_sackhdr *);
1146 int sctp_outq_is_empty(const struct sctp_outq *);
1147 void sctp_outq_restart(struct sctp_outq *);
1149 void sctp_retransmit(struct sctp_outq *, struct sctp_transport *,
1150 sctp_retransmit_reason_t);
1151 void sctp_retransmit_mark(struct sctp_outq *, struct sctp_transport *, __u8);
1152 int sctp_outq_uncork(struct sctp_outq *);
1153 /* Uncork and flush an outqueue. */
1154 static inline void sctp_outq_cork(struct sctp_outq *q)
1159 /* These bind address data fields common between endpoints and associations */
1160 struct sctp_bind_addr {
1162 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1164 * SCTP Port: The local SCTP port number the endpoint is
1169 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1171 * Address List: The list of IP addresses that this instance
1172 * has bound. This information is passed to one's
1173 * peer(s) in INIT and INIT ACK chunks.
1175 struct list_head address_list;
1177 int malloced; /* Are we kfree()able? */
1180 void sctp_bind_addr_init(struct sctp_bind_addr *, __u16 port);
1181 void sctp_bind_addr_free(struct sctp_bind_addr *);
1182 int sctp_bind_addr_copy(struct sctp_bind_addr *dest,
1183 const struct sctp_bind_addr *src,
1184 sctp_scope_t scope, gfp_t gfp,
1186 int sctp_add_bind_addr(struct sctp_bind_addr *, union sctp_addr *,
1187 __u8 use_as_src, gfp_t gfp);
1188 int sctp_del_bind_addr(struct sctp_bind_addr *, union sctp_addr *);
1189 int sctp_bind_addr_match(struct sctp_bind_addr *, const union sctp_addr *,
1190 struct sctp_sock *);
1191 union sctp_addr *sctp_find_unmatch_addr(struct sctp_bind_addr *bp,
1192 const union sctp_addr *addrs,
1194 struct sctp_sock *opt);
1195 union sctp_params sctp_bind_addrs_to_raw(const struct sctp_bind_addr *bp,
1198 int sctp_raw_to_bind_addrs(struct sctp_bind_addr *bp, __u8 *raw, int len,
1199 __u16 port, gfp_t gfp);
1201 sctp_scope_t sctp_scope(const union sctp_addr *);
1202 int sctp_in_scope(const union sctp_addr *addr, const sctp_scope_t scope);
1203 int sctp_is_any(const union sctp_addr *addr);
1204 int sctp_addr_is_valid(const union sctp_addr *addr);
1207 /* What type of endpoint? */
1209 SCTP_EP_TYPE_SOCKET,
1210 SCTP_EP_TYPE_ASSOCIATION,
1211 } sctp_endpoint_type_t;
1214 * A common base class to bridge the implmentation view of a
1215 * socket (usually listening) endpoint versus an association's
1217 * This common structure is useful for several purposes:
1218 * 1) Common interface for lookup routines.
1219 * a) Subfunctions work for either endpoint or association
1220 * b) Single interface to lookup allows hiding the lookup lock rather
1221 * than acquiring it externally.
1222 * 2) Common interface for the inbound chunk handling/state machine.
1223 * 3) Common object handling routines for reference counting, etc.
1224 * 4) Disentangle association lookup from endpoint lookup, where we
1225 * do not have to find our endpoint to find our association.
1229 struct sctp_ep_common {
1230 /* Fields to help us manage our entries in the hash tables. */
1231 struct sctp_ep_common *next;
1232 struct sctp_ep_common **pprev;
1235 /* Runtime type information. What kind of endpoint is this? */
1236 sctp_endpoint_type_t type;
1238 /* Some fields to help us manage this object.
1239 * refcnt - Reference count access to this object.
1240 * dead - Do not attempt to use this object.
1241 * malloced - Do we need to kfree this object?
1247 /* What socket does this endpoint belong to? */
1250 /* This is where we receive inbound chunks. */
1251 struct sctp_inq inqueue;
1253 /* This substructure includes the defining parameters of the
1255 * bind_addr.port is our shared port number.
1256 * bind_addr.address_list is our set of local IP addresses.
1258 struct sctp_bind_addr bind_addr;
1262 /* RFC Section 1.4 Key Terms
1264 * o SCTP endpoint: The logical sender/receiver of SCTP packets. On a
1265 * multi-homed host, an SCTP endpoint is represented to its peers as a
1266 * combination of a set of eligible destination transport addresses to
1267 * which SCTP packets can be sent and a set of eligible source
1268 * transport addresses from which SCTP packets can be received.
1269 * All transport addresses used by an SCTP endpoint must use the
1270 * same port number, but can use multiple IP addresses. A transport
1271 * address used by an SCTP endpoint must not be used by another
1272 * SCTP endpoint. In other words, a transport address is unique
1273 * to an SCTP endpoint.
1275 * From an implementation perspective, each socket has one of these.
1276 * A TCP-style socket will have exactly one association on one of
1277 * these. An UDP-style socket will have multiple associations hanging
1281 struct sctp_endpoint {
1282 /* Common substructure for endpoint and association. */
1283 struct sctp_ep_common base;
1285 /* Associations: A list of current associations and mappings
1286 * to the data consumers for each association. This
1287 * may be in the form of a hash table or other
1288 * implementation dependent structure. The data
1289 * consumers may be process identification
1290 * information such as file descriptors, named pipe
1291 * pointer, or table pointers dependent on how SCTP
1294 /* This is really a list of struct sctp_association entries. */
1295 struct list_head asocs;
1297 /* Secret Key: A secret key used by this endpoint to compute
1298 * the MAC. This SHOULD be a cryptographic quality
1299 * random number with a sufficient length.
1300 * Discussion in [RFC1750] can be helpful in
1301 * selection of the key.
1303 __u8 secret_key[SCTP_HOW_MANY_SECRETS][SCTP_SECRET_SIZE];
1308 /* digest: This is a digest of the sctp cookie. This field is
1309 * only used on the receive path when we try to validate
1310 * that the cookie has not been tampered with. We put
1311 * this here so we pre-allocate this once and can re-use
1316 /* sendbuf acct. policy. */
1317 __u32 sndbuf_policy;
1319 /* rcvbuf acct. policy. */
1320 __u32 rcvbuf_policy;
1322 /* SCTP AUTH: array of the HMACs that will be allocated
1323 * we need this per association so that we don't serialize
1325 struct crypto_hash **auth_hmacs;
1327 /* SCTP-AUTH: hmacs for the endpoint encoded into parameter */
1328 struct sctp_hmac_algo_param *auth_hmacs_list;
1330 /* SCTP-AUTH: chunks to authenticate encoded into parameter */
1331 struct sctp_chunks_param *auth_chunk_list;
1333 /* SCTP-AUTH: endpoint shared keys */
1334 struct list_head endpoint_shared_keys;
1335 __u16 active_key_id;
1338 /* Recover the outter endpoint structure. */
1339 static inline struct sctp_endpoint *sctp_ep(struct sctp_ep_common *base)
1341 struct sctp_endpoint *ep;
1343 ep = container_of(base, struct sctp_endpoint, base);
1347 /* These are function signatures for manipulating endpoints. */
1348 struct sctp_endpoint *sctp_endpoint_new(struct sock *, gfp_t);
1349 void sctp_endpoint_free(struct sctp_endpoint *);
1350 void sctp_endpoint_put(struct sctp_endpoint *);
1351 void sctp_endpoint_hold(struct sctp_endpoint *);
1352 void sctp_endpoint_add_asoc(struct sctp_endpoint *, struct sctp_association *);
1353 struct sctp_association *sctp_endpoint_lookup_assoc(
1354 const struct sctp_endpoint *ep,
1355 const union sctp_addr *paddr,
1356 struct sctp_transport **);
1357 int sctp_endpoint_is_peeled_off(struct sctp_endpoint *,
1358 const union sctp_addr *);
1359 struct sctp_endpoint *sctp_endpoint_is_match(struct sctp_endpoint *,
1360 const union sctp_addr *);
1361 int sctp_has_association(const union sctp_addr *laddr,
1362 const union sctp_addr *paddr);
1364 int sctp_verify_init(const struct sctp_association *asoc, sctp_cid_t,
1365 sctp_init_chunk_t *peer_init, struct sctp_chunk *chunk,
1366 struct sctp_chunk **err_chunk);
1367 int sctp_process_init(struct sctp_association *, sctp_cid_t cid,
1368 const union sctp_addr *peer,
1369 sctp_init_chunk_t *init, gfp_t gfp);
1370 __u32 sctp_generate_tag(const struct sctp_endpoint *);
1371 __u32 sctp_generate_tsn(const struct sctp_endpoint *);
1373 struct sctp_inithdr_host {
1376 __u16 num_outbound_streams;
1377 __u16 num_inbound_streams;
1383 * 12. Recommended Transmission Control Block (TCB) Parameters
1385 * This section details a recommended set of parameters that should
1386 * be contained within the TCB for an implementation. This section is
1387 * for illustrative purposes and should not be deemed as requirements
1388 * on an implementation or as an exhaustive list of all parameters
1389 * inside an SCTP TCB. Each implementation may need its own additional
1390 * parameters for optimization.
1394 /* Here we have information about each individual association. */
1395 struct sctp_association {
1397 /* A base structure common to endpoint and association.
1398 * In this context, it represents the associations's view
1399 * of the local endpoint of the association.
1401 struct sctp_ep_common base;
1403 /* Associations on the same socket. */
1404 struct list_head asocs;
1406 /* association id. */
1407 sctp_assoc_t assoc_id;
1409 /* This is our parent endpoint. */
1410 struct sctp_endpoint *ep;
1412 /* These are those association elements needed in the cookie. */
1413 struct sctp_cookie c;
1415 /* This is all information about our peer. */
1419 * Peer Rwnd : Current calculated value of the peer's rwnd.
1423 /* transport_addr_list
1425 * Peer : A list of SCTP transport addresses that the
1426 * Transport : peer is bound to. This information is derived
1427 * Address : from the INIT or INIT ACK and is used to
1428 * List : associate an inbound packet with a given
1429 * : association. Normally this information is
1430 * : hashed or keyed for quick lookup and access
1432 * : The list is also initialized with the list
1433 * : of addresses passed with the sctp_connectx()
1436 * It is a list of SCTP_transport's.
1438 struct list_head transport_addr_list;
1442 * Peer : A count of the number of peer addresses
1443 * Transport : in the Peer Transport Address List.
1447 __u16 transport_count;
1450 * The transport layer port number.
1456 * Primary : This is the current primary destination
1457 * Path : transport address of the peer endpoint. It
1458 * : may also specify a source transport address
1459 * : on this endpoint.
1461 * All of these paths live on transport_addr_list.
1463 * At the bakeoffs, we discovered that the intent of
1464 * primaryPath is that it only changes when the ULP
1465 * asks to have it changed. We add the activePath to
1466 * designate the connection we are currently using to
1467 * transmit new data and most control chunks.
1469 struct sctp_transport *primary_path;
1471 /* Cache the primary path address here, when we
1472 * need a an address for msg_name.
1474 union sctp_addr primary_addr;
1477 * The path that we are currently using to
1478 * transmit new data and most control chunks.
1480 struct sctp_transport *active_path;
1484 * RFC2960 6.4 Multi-homed SCTP Endpoints
1486 * Furthermore, when its peer is multi-homed, an
1487 * endpoint SHOULD try to retransmit a chunk to an
1488 * active destination transport address that is
1489 * different from the last destination address to
1490 * which the DATA chunk was sent.
1492 struct sctp_transport *retran_path;
1494 /* Pointer to last transport I have sent on. */
1495 struct sctp_transport *last_sent_to;
1497 /* This is the last transport I have received DATA on. */
1498 struct sctp_transport *last_data_from;
1501 * Mapping An array of bits or bytes indicating which out of
1502 * Array order TSN's have been received (relative to the
1503 * Last Rcvd TSN). If no gaps exist, i.e. no out of
1504 * order packets have been received, this array
1505 * will be set to all zero. This structure may be
1506 * in the form of a circular buffer or bit array.
1508 * Last Rcvd : This is the last TSN received in
1509 * TSN : sequence. This value is set initially by
1510 * : taking the peer's Initial TSN, received in
1511 * : the INIT or INIT ACK chunk, and subtracting
1514 * Throughout most of the specification this is called the
1515 * "Cumulative TSN ACK Point". In this case, we
1516 * ignore the advice in 12.2 in favour of the term
1517 * used in the bulk of the text. This value is hidden
1518 * in tsn_map--we get it by calling sctp_tsnmap_get_ctsn().
1520 struct sctp_tsnmap tsn_map;
1521 __u8 _map[sctp_tsnmap_storage_size(SCTP_TSN_MAP_SIZE)];
1523 /* Ack State : This flag indicates if the next received
1524 * : packet is to be responded to with a
1525 * : SACK. This is initializedto 0. When a packet
1526 * : is received it is incremented. If this value
1527 * : reaches 2 or more, a SACK is sent and the
1528 * : value is reset to 0. Note: This is used only
1529 * : when no DATA chunks are received out of
1530 * : order. When DATA chunks are out of order,
1531 * : SACK's are not delayed (see Section 6).
1533 __u8 sack_needed; /* Do we need to sack the peer? */
1535 /* These are capabilities which our peer advertised. */
1536 __u8 ecn_capable; /* Can peer do ECN? */
1537 __u8 ipv4_address; /* Peer understands IPv4 addresses? */
1538 __u8 ipv6_address; /* Peer understands IPv6 addresses? */
1539 __u8 hostname_address;/* Peer understands DNS addresses? */
1540 __u8 asconf_capable; /* Does peer support ADDIP? */
1541 __u8 prsctp_capable; /* Can peer do PR-SCTP? */
1542 __u8 auth_capable; /* Is peer doing SCTP-AUTH? */
1543 __u8 addip_capable; /* Can peer do ADD-IP */
1545 __u32 adaptation_ind; /* Adaptation Code point. */
1547 /* This mask is used to disable sending the ASCONF chunk
1548 * with specified parameter to peer.
1550 __be16 addip_disabled_mask;
1552 struct sctp_inithdr_host i;
1556 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
1557 * C1) ... "Peer-Serial-Number'. This value MUST be initialized to the
1558 * Initial TSN Value minus 1
1562 /* SCTP-AUTH: We need to know pears random number, hmac list
1563 * and authenticated chunk list. All that is part of the
1564 * cookie and these are just pointers to those locations
1566 sctp_random_param_t *peer_random;
1567 sctp_chunks_param_t *peer_chunks;
1568 sctp_hmac_algo_param_t *peer_hmacs;
1571 /* State : A state variable indicating what state the
1572 * : association is in, i.e. COOKIE-WAIT,
1573 * : COOKIE-ECHOED, ESTABLISHED, SHUTDOWN-PENDING,
1574 * : SHUTDOWN-SENT, SHUTDOWN-RECEIVED, SHUTDOWN-ACK-SENT.
1576 * Note: No "CLOSED" state is illustrated since if a
1577 * association is "CLOSED" its TCB SHOULD be removed.
1579 * In this implementation we DO have a CLOSED
1580 * state which is used during initiation and shutdown.
1582 * State takes values from SCTP_STATE_*.
1586 /* The cookie life I award for any cookie. */
1587 struct timeval cookie_life;
1589 /* Overall : The overall association error count.
1590 * Error Count : [Clear this any time I get something.]
1592 int overall_error_count;
1594 /* These are the association's initial, max, and min RTO values.
1595 * These values will be initialized by system defaults, but can
1596 * be modified via the SCTP_RTOINFO socket option.
1598 unsigned long rto_initial;
1599 unsigned long rto_max;
1600 unsigned long rto_min;
1602 /* Maximum number of new data packets that can be sent in a burst. */
1605 /* This is the max_retrans value for the association. This value will
1606 * be initialized initialized from system defaults, but can be
1607 * modified by the SCTP_ASSOCINFO socket option.
1611 /* Maximum number of times the endpoint will retransmit INIT */
1612 __u16 max_init_attempts;
1614 /* How many times have we resent an INIT? */
1617 /* The largest timeout or RTO value to use in attempting an INIT */
1618 unsigned long max_init_timeo;
1620 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
1621 * the destination address every heartbeat interval. This value
1622 * will be inherited by all new transports.
1624 unsigned long hbinterval;
1626 /* This is the max_retrans value for new transports in the
1631 /* Flag that path mtu update is pending */
1634 /* Association : The smallest PMTU discovered for all of the
1635 * PMTU : peer's transport addresses.
1639 /* Flags controling Heartbeat, SACK delay, and Path MTU Discovery. */
1642 /* SACK delay timeout */
1643 unsigned long sackdelay;
1646 unsigned long timeouts[SCTP_NUM_TIMEOUT_TYPES];
1647 struct timer_list timers[SCTP_NUM_TIMEOUT_TYPES];
1649 /* Transport to which SHUTDOWN chunk was last sent. */
1650 struct sctp_transport *shutdown_last_sent_to;
1652 /* Transport to which INIT chunk was last sent. */
1653 struct sctp_transport *init_last_sent_to;
1655 /* Next TSN : The next TSN number to be assigned to a new
1656 * : DATA chunk. This is sent in the INIT or INIT
1657 * : ACK chunk to the peer and incremented each
1658 * : time a DATA chunk is assigned a TSN
1659 * : (normally just prior to transmit or during
1665 * Last Rcvd : This is the last TSN received in sequence. This value
1666 * TSN : is set initially by taking the peer's Initial TSN,
1667 * : received in the INIT or INIT ACK chunk, and
1668 * : subtracting one from it.
1670 * Most of RFC 2960 refers to this as the Cumulative TSN Ack Point.
1673 __u32 ctsn_ack_point;
1675 /* PR-SCTP Advanced.Peer.Ack.Point */
1676 __u32 adv_peer_ack_point;
1678 /* Highest TSN that is acknowledged by incoming SACKs. */
1679 __u32 highest_sacked;
1681 /* The number of unacknowledged data chunks. Reported through
1682 * the SCTP_STATUS sockopt.
1686 /* This is the association's receive buffer space. This value is used
1687 * to set a_rwnd field in an INIT or a SACK chunk.
1691 /* This is the last advertised value of rwnd over a SACK chunk. */
1694 /* Number of bytes by which the rwnd has slopped. The rwnd is allowed
1695 * to slop over a maximum of the association's frag_point.
1699 /* This is the sndbuf size in use for the association.
1700 * This corresponds to the sndbuf size for the association,
1701 * as specified in the sk->sndbuf.
1705 /* This is the amount of memory that this association has allocated
1706 * in the receive path at any given time.
1708 atomic_t rmem_alloc;
1710 /* This is the wait queue head for send requests waiting on
1711 * the association sndbuf space.
1713 wait_queue_head_t wait;
1715 /* The message size at which SCTP fragmentation will occur. */
1718 /* Counter used to count INIT errors. */
1719 int init_err_counter;
1721 /* Count the number of INIT cycles (for doubling timeout). */
1724 /* Default send parameters. */
1725 __u16 default_stream;
1726 __u16 default_flags;
1728 __u32 default_context;
1729 __u32 default_timetolive;
1731 /* Default receive parameters */
1732 __u32 default_rcv_context;
1734 /* This tracks outbound ssn for a given stream. */
1735 struct sctp_ssnmap *ssnmap;
1737 /* All outbound chunks go through this structure. */
1738 struct sctp_outq outqueue;
1740 /* A smart pipe that will handle reordering and fragmentation,
1741 * as well as handle passing events up to the ULP.
1743 struct sctp_ulpq ulpq;
1745 /* Last TSN that caused an ECNE Chunk to be sent. */
1746 __u32 last_ecne_tsn;
1748 /* Last TSN that caused a CWR Chunk to be sent. */
1751 /* How many duplicated TSNs have we seen? */
1754 /* Number of seconds of idle time before an association is closed.
1755 * In the association context, this is really used as a boolean
1756 * since the real timeout is stored in the timeouts array
1760 /* These are to support
1761 * "SCTP Extensions for Dynamic Reconfiguration of IP Addresses
1762 * and Enforcement of Flow and Message Limits"
1763 * <draft-ietf-tsvwg-addip-sctp-02.txt>
1764 * or "ADDIP" for short.
1769 /* ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1771 * R1) One and only one ASCONF Chunk MAY be in transit and
1772 * unacknowledged at any one time. If a sender, after sending
1773 * an ASCONF chunk, decides it needs to transfer another
1774 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1775 * returns from the previous ASCONF Chunk before sending a
1776 * subsequent ASCONF. Note this restriction binds each side,
1777 * so at any time two ASCONF may be in-transit on any given
1778 * association (one sent from each endpoint).
1780 * [This is our one-and-only-one ASCONF in flight. If we do
1781 * not have an ASCONF in flight, this is NULL.]
1783 struct sctp_chunk *addip_last_asconf;
1785 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
1787 * IMPLEMENTATION NOTE: As an optimization a receiver may wish
1788 * to save the last ASCONF-ACK for some predetermined period
1789 * of time and instead of re-processing the ASCONF (with the
1790 * same serial number) it may just re-transmit the
1791 * ASCONF-ACK. It may wish to use the arrival of a new serial
1792 * number to discard the previously saved ASCONF-ACK or any
1793 * other means it may choose to expire the saved ASCONF-ACK.
1795 * [This is our saved ASCONF-ACK. We invalidate it when a new
1796 * ASCONF serial number arrives.]
1798 struct sctp_chunk *addip_last_asconf_ack;
1800 /* These ASCONF chunks are waiting to be sent.
1802 * These chunaks can't be pushed to outqueue until receiving
1803 * ASCONF_ACK for the previous ASCONF indicated by
1804 * addip_last_asconf, so as to guarantee that only one ASCONF
1805 * is in flight at any time.
1807 * ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1809 * In defining the ASCONF Chunk transfer procedures, it is
1810 * essential that these transfers MUST NOT cause congestion
1811 * within the network. To achieve this, we place these
1812 * restrictions on the transfer of ASCONF Chunks:
1814 * R1) One and only one ASCONF Chunk MAY be in transit and
1815 * unacknowledged at any one time. If a sender, after sending
1816 * an ASCONF chunk, decides it needs to transfer another
1817 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1818 * returns from the previous ASCONF Chunk before sending a
1819 * subsequent ASCONF. Note this restriction binds each side,
1820 * so at any time two ASCONF may be in-transit on any given
1821 * association (one sent from each endpoint).
1824 * [I really think this is EXACTLY the sort of intelligence
1825 * which already resides in sctp_outq. Please move this
1826 * queue and its supporting logic down there. --piggy]
1828 struct list_head addip_chunk_list;
1830 /* ADDIP Section 4.1 ASCONF Chunk Procedures
1832 * A2) A serial number should be assigned to the Chunk. The
1833 * serial number SHOULD be a monotonically increasing
1834 * number. The serial number SHOULD be initialized at
1835 * the start of the association to the same value as the
1836 * Initial TSN and every time a new ASCONF chunk is created
1837 * it is incremented by one after assigning the serial number
1838 * to the newly created chunk.
1841 * 3.1.1 Address/Stream Configuration Change Chunk (ASCONF)
1843 * Serial Number : 32 bits (unsigned integer)
1845 * This value represents a Serial Number for the ASCONF
1846 * Chunk. The valid range of Serial Number is from 0 to
1847 * 4294967295 (2^32 - 1). Serial Numbers wrap back to 0
1848 * after reaching 4294967295.
1852 /* SCTP AUTH: list of the endpoint shared keys. These
1853 * keys are provided out of band by the user applicaton
1854 * and can't change during the lifetime of the association
1856 struct list_head endpoint_shared_keys;
1859 * The current generated assocaition shared key (secret)
1861 struct sctp_auth_bytes *asoc_shared_key;
1863 /* SCTP AUTH: hmac id of the first peer requested algorithm
1866 __u16 default_hmac_id;
1868 __u16 active_key_id;
1870 /* Need to send an ECNE Chunk? */
1873 /* Is it a temporary association? */
1878 /* An eyecatcher for determining if we are really looking at an
1879 * association data structure.
1882 SCTP_ASSOC_EYECATCHER = 0xa550c123,
1885 /* Recover the outter association structure. */
1886 static inline struct sctp_association *sctp_assoc(struct sctp_ep_common *base)
1888 struct sctp_association *asoc;
1890 asoc = container_of(base, struct sctp_association, base);
1894 /* These are function signatures for manipulating associations. */
1897 struct sctp_association *
1898 sctp_association_new(const struct sctp_endpoint *, const struct sock *,
1899 sctp_scope_t scope, gfp_t gfp);
1900 void sctp_association_free(struct sctp_association *);
1901 void sctp_association_put(struct sctp_association *);
1902 void sctp_association_hold(struct sctp_association *);
1904 struct sctp_transport *sctp_assoc_choose_init_transport(
1905 struct sctp_association *);
1906 struct sctp_transport *sctp_assoc_choose_shutdown_transport(
1907 struct sctp_association *);
1908 void sctp_assoc_update_retran_path(struct sctp_association *);
1909 struct sctp_transport *sctp_assoc_lookup_paddr(const struct sctp_association *,
1910 const union sctp_addr *);
1911 int sctp_assoc_lookup_laddr(struct sctp_association *asoc,
1912 const union sctp_addr *laddr);
1913 struct sctp_transport *sctp_assoc_add_peer(struct sctp_association *,
1914 const union sctp_addr *address,
1916 const int peer_state);
1917 void sctp_assoc_del_peer(struct sctp_association *asoc,
1918 const union sctp_addr *addr);
1919 void sctp_assoc_rm_peer(struct sctp_association *asoc,
1920 struct sctp_transport *peer);
1921 void sctp_assoc_control_transport(struct sctp_association *,
1922 struct sctp_transport *,
1923 sctp_transport_cmd_t, sctp_sn_error_t);
1924 struct sctp_transport *sctp_assoc_lookup_tsn(struct sctp_association *, __u32);
1925 struct sctp_transport *sctp_assoc_is_match(struct sctp_association *,
1926 const union sctp_addr *,
1927 const union sctp_addr *);
1928 void sctp_assoc_migrate(struct sctp_association *, struct sock *);
1929 void sctp_assoc_update(struct sctp_association *old,
1930 struct sctp_association *new);
1932 __u32 sctp_association_get_next_tsn(struct sctp_association *);
1934 void sctp_assoc_sync_pmtu(struct sctp_association *);
1935 void sctp_assoc_rwnd_increase(struct sctp_association *, unsigned);
1936 void sctp_assoc_rwnd_decrease(struct sctp_association *, unsigned);
1937 void sctp_assoc_set_primary(struct sctp_association *,
1938 struct sctp_transport *);
1939 int sctp_assoc_set_bind_addr_from_ep(struct sctp_association *,
1941 int sctp_assoc_set_bind_addr_from_cookie(struct sctp_association *,
1942 struct sctp_cookie*,
1944 int sctp_assoc_set_id(struct sctp_association *, gfp_t);
1946 int sctp_cmp_addr_exact(const union sctp_addr *ss1,
1947 const union sctp_addr *ss2);
1948 struct sctp_chunk *sctp_get_ecne_prepend(struct sctp_association *asoc);
1950 /* A convenience structure to parse out SCTP specific CMSGs. */
1951 typedef struct sctp_cmsgs {
1952 struct sctp_initmsg *init;
1953 struct sctp_sndrcvinfo *info;
1956 /* Structure for tracking memory objects */
1960 } sctp_dbg_objcnt_entry_t;
1962 #endif /* __sctp_structs_h__ */