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, 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 <linux/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 hlist_node node;
104 struct hlist_head owner;
107 struct sctp_bind_hashbucket {
109 struct hlist_head chain;
112 /* Used for hashing all associations. */
113 struct sctp_hashbucket {
115 struct hlist_head chain;
116 } __attribute__((__aligned__(8)));
119 /* The SCTP globals structure. */
120 extern struct sctp_globals {
121 /* RFC2960 Section 14. Suggested SCTP Protocol Parameter Values
123 * The following protocol parameters are RECOMMENDED:
125 * RTO.Initial - 3 seconds
127 * RTO.Max - 60 seconds
128 * RTO.Alpha - 1/8 (3 when converted to right shifts.)
129 * RTO.Beta - 1/4 (2 when converted to right shifts.)
131 unsigned int rto_initial;
132 unsigned int rto_min;
133 unsigned int rto_max;
135 /* Note: rto_alpha and rto_beta are really defined as inverse
136 * powers of two to facilitate integer operations.
144 /* Whether Cookie Preservative is enabled(1) or not(0) */
145 int cookie_preserve_enable;
147 /* Valid.Cookie.Life - 60 seconds */
148 unsigned int valid_cookie_life;
150 /* Delayed SACK timeout 200ms default*/
151 unsigned int sack_timeout;
153 /* HB.interval - 30 seconds */
154 unsigned int hb_interval;
156 /* Association.Max.Retrans - 10 attempts
157 * Path.Max.Retrans - 5 attempts (per destination address)
158 * Max.Init.Retransmits - 8 attempts
160 int max_retrans_association;
161 int max_retrans_path;
162 int max_retrans_init;
165 * Policy for preforming sctp/socket accounting
166 * 0 - do socket level accounting, all assocs share sk_sndbuf
167 * 1 - do sctp accounting, each asoc may use sk_sndbuf bytes
172 * Policy for preforming sctp/socket accounting
173 * 0 - do socket level accounting, all assocs share sk_rcvbuf
174 * 1 - do sctp accounting, each asoc may use sk_rcvbuf bytes
178 /* The following variables are implementation specific. */
180 /* Default initialization values to be applied to new associations. */
182 __u16 max_outstreams;
184 /* This is a list of groups of functions for each address
185 * family that we support.
187 struct list_head address_families;
189 /* This is the hash of all endpoints. */
191 struct sctp_hashbucket *ep_hashtable;
193 /* This is the hash of all associations. */
195 struct sctp_hashbucket *assoc_hashtable;
197 /* This is the sctp port control hash. */
199 struct sctp_bind_hashbucket *port_hashtable;
201 /* This is the global local address list.
202 * We actively maintain this complete list of addresses on
203 * the system by catching address add/delete events.
205 * It is a list of sctp_sockaddr_entry.
207 struct list_head local_addr_list;
208 int default_auto_asconf;
209 struct list_head addr_waitq;
210 struct timer_list addr_wq_timer;
211 struct list_head auto_asconf_splist;
212 /* Lock that protects both addr_waitq and auto_asconf_splist */
213 spinlock_t addr_wq_lock;
215 /* Lock that protects the local_addr_list writers */
216 spinlock_t addr_list_lock;
218 /* Flag to indicate if addip is enabled. */
220 int addip_noauth_enable;
222 /* Flag to indicate if PR-SCTP is enabled. */
225 /* Flag to idicate if SCTP-AUTH is enabled */
229 * Policy to control SCTP IPv4 address scoping
230 * 0 - Disable IPv4 address scoping
231 * 1 - Enable IPv4 address scoping
232 * 2 - Selectively allow only IPv4 private addresses
233 * 3 - Selectively allow only IPv4 link local address
235 int ipv4_scope_policy;
237 /* Flag to indicate whether computing and verifying checksum
239 int checksum_disable;
241 /* Threshold for rwnd update SACKS. Receive buffer shifted this many
242 * bits is an indicator of when to send and window update SACK.
244 int rwnd_update_shift;
246 /* Threshold for autoclose timeout, in seconds. */
247 unsigned long max_autoclose;
250 #define sctp_rto_initial (sctp_globals.rto_initial)
251 #define sctp_rto_min (sctp_globals.rto_min)
252 #define sctp_rto_max (sctp_globals.rto_max)
253 #define sctp_rto_alpha (sctp_globals.rto_alpha)
254 #define sctp_rto_beta (sctp_globals.rto_beta)
255 #define sctp_max_burst (sctp_globals.max_burst)
256 #define sctp_valid_cookie_life (sctp_globals.valid_cookie_life)
257 #define sctp_cookie_preserve_enable (sctp_globals.cookie_preserve_enable)
258 #define sctp_max_retrans_association (sctp_globals.max_retrans_association)
259 #define sctp_sndbuf_policy (sctp_globals.sndbuf_policy)
260 #define sctp_rcvbuf_policy (sctp_globals.rcvbuf_policy)
261 #define sctp_max_retrans_path (sctp_globals.max_retrans_path)
262 #define sctp_max_retrans_init (sctp_globals.max_retrans_init)
263 #define sctp_sack_timeout (sctp_globals.sack_timeout)
264 #define sctp_hb_interval (sctp_globals.hb_interval)
265 #define sctp_max_instreams (sctp_globals.max_instreams)
266 #define sctp_max_outstreams (sctp_globals.max_outstreams)
267 #define sctp_address_families (sctp_globals.address_families)
268 #define sctp_ep_hashsize (sctp_globals.ep_hashsize)
269 #define sctp_ep_hashtable (sctp_globals.ep_hashtable)
270 #define sctp_assoc_hashsize (sctp_globals.assoc_hashsize)
271 #define sctp_assoc_hashtable (sctp_globals.assoc_hashtable)
272 #define sctp_port_hashsize (sctp_globals.port_hashsize)
273 #define sctp_port_hashtable (sctp_globals.port_hashtable)
274 #define sctp_local_addr_list (sctp_globals.local_addr_list)
275 #define sctp_local_addr_lock (sctp_globals.addr_list_lock)
276 #define sctp_auto_asconf_splist (sctp_globals.auto_asconf_splist)
277 #define sctp_addr_waitq (sctp_globals.addr_waitq)
278 #define sctp_addr_wq_timer (sctp_globals.addr_wq_timer)
279 #define sctp_addr_wq_lock (sctp_globals.addr_wq_lock)
280 #define sctp_default_auto_asconf (sctp_globals.default_auto_asconf)
281 #define sctp_scope_policy (sctp_globals.ipv4_scope_policy)
282 #define sctp_addip_enable (sctp_globals.addip_enable)
283 #define sctp_addip_noauth (sctp_globals.addip_noauth_enable)
284 #define sctp_prsctp_enable (sctp_globals.prsctp_enable)
285 #define sctp_auth_enable (sctp_globals.auth_enable)
286 #define sctp_checksum_disable (sctp_globals.checksum_disable)
287 #define sctp_rwnd_upd_shift (sctp_globals.rwnd_update_shift)
288 #define sctp_max_autoclose (sctp_globals.max_autoclose)
290 /* SCTP Socket type: UDP or TCP style. */
293 SCTP_SOCKET_UDP_HIGH_BANDWIDTH,
295 } sctp_socket_type_t;
297 /* Per socket SCTP information. */
299 /* inet_sock has to be the first member of sctp_sock */
300 struct inet_sock inet;
301 /* What kind of a socket is this? */
302 sctp_socket_type_t type;
304 /* PF_ family specific functions. */
307 /* Access to HMAC transform. */
308 struct crypto_hash *hmac;
310 /* What is our base endpointer? */
311 struct sctp_endpoint *ep;
313 struct sctp_bind_bucket *bind_hash;
314 /* Various Socket Options. */
315 __u16 default_stream;
318 __u32 default_context;
319 __u32 default_timetolive;
320 __u32 default_rcv_context;
323 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
324 * the destination address every heartbeat interval. This value
325 * will be inherited by all new associations.
329 /* This is the max_retrans value for new associations. */
332 /* The initial Path MTU to use for new associations. */
335 /* The default SACK delay timeout for new associations. */
339 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
342 struct sctp_initmsg initmsg;
343 struct sctp_rtoinfo rtoinfo;
344 struct sctp_paddrparams paddrparam;
345 struct sctp_event_subscribe subscribe;
346 struct sctp_assocparams assocparams;
350 __u8 disable_fragments;
352 __u8 frag_interleave;
353 __u32 adaptation_ind;
357 /* Receive to here while partial delivery is in effect. */
358 struct sk_buff_head pd_lobby;
360 /* These must be the last fields, as they will skipped on copies,
361 * like on accept and peeloff operations
363 struct list_head auto_asconf_list;
367 static inline struct sctp_sock *sctp_sk(const struct sock *sk)
369 return (struct sctp_sock *)sk;
372 static inline struct sock *sctp_opt2sk(const struct sctp_sock *sp)
374 return (struct sock *)sp;
377 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
379 struct sctp_sock sctp;
380 struct ipv6_pinfo inet6;
382 #endif /* CONFIG_IPV6 */
385 /* This is our APPLICATION-SPECIFIC state cookie.
386 * THIS IS NOT DICTATED BY THE SPECIFICATION.
388 /* These are the parts of an association which we send in the cookie.
389 * Most of these are straight out of:
390 * RFC2960 12.2 Parameters necessary per association (i.e. the TCB)
396 /* My : Tag expected in every inbound packet and sent
397 * Verification: in the INIT or INIT ACK chunk.
402 /* Peer's : Tag expected in every outbound packet except
403 * Verification: in the INIT chunk.
408 /* The rest of these are not from the spec, but really need to
412 /* My Tie Tag : Assist in discovering a restarting association. */
415 /* Peer's Tie Tag: Assist in discovering a restarting association. */
418 /* When does this cookie expire? */
419 struct timeval expiration;
421 /* Number of inbound/outbound streams which are set
422 * and negotiated during the INIT process.
424 __u16 sinit_num_ostreams;
425 __u16 sinit_max_instreams;
427 /* This is the first sequence number I used. */
430 /* This holds the originating address of the INIT packet. */
431 union sctp_addr peer_addr;
434 * Include the source port of the INIT-ACK
440 /* Padding for future use */
443 __u32 adaptation_ind;
445 __u8 auth_random[sizeof(sctp_paramhdr_t) + SCTP_AUTH_RANDOM_LENGTH];
446 __u8 auth_hmacs[SCTP_AUTH_NUM_HMACS * sizeof(__u16) + 2];
447 __u8 auth_chunks[sizeof(sctp_paramhdr_t) + SCTP_AUTH_MAX_CHUNKS];
449 /* This is a shim for my peer's INIT packet, followed by
450 * a copy of the raw address list of the association.
451 * The length of the raw address list is saved in the
452 * raw_addr_list_len field, which will be used at the time when
453 * the association TCB is re-constructed from the cookie.
455 __u32 raw_addr_list_len;
456 struct sctp_init_chunk peer_init[0];
460 /* The format of our cookie that we send to our peer. */
461 struct sctp_signed_cookie {
462 __u8 signature[SCTP_SECRET_SIZE];
463 __u32 __pad; /* force sctp_cookie alignment to 64 bits */
464 struct sctp_cookie c;
467 /* This is another convenience type to allocate memory for address
468 * params for the maximum size and pass such structures around
471 union sctp_addr_param {
472 struct sctp_paramhdr p;
473 struct sctp_ipv4addr_param v4;
474 struct sctp_ipv6addr_param v6;
477 /* A convenience type to allow walking through the various
478 * parameters and avoid casting all over the place.
482 struct sctp_paramhdr *p;
483 struct sctp_cookie_preserve_param *life;
484 struct sctp_hostname_param *dns;
485 struct sctp_cookie_param *cookie;
486 struct sctp_supported_addrs_param *sat;
487 struct sctp_ipv4addr_param *v4;
488 struct sctp_ipv6addr_param *v6;
489 union sctp_addr_param *addr;
490 struct sctp_adaptation_ind_param *aind;
491 struct sctp_supported_ext_param *ext;
492 struct sctp_random_param *random;
493 struct sctp_chunks_param *chunks;
494 struct sctp_hmac_algo_param *hmac_algo;
495 struct sctp_addip_param *addip;
498 /* RFC 2960. Section 3.3.5 Heartbeat.
499 * Heartbeat Information: variable length
500 * The Sender-specific Heartbeat Info field should normally include
501 * information about the sender's current time when this HEARTBEAT
502 * chunk is sent and the destination transport address to which this
503 * HEARTBEAT is sent (see Section 8.3).
505 typedef struct sctp_sender_hb_info {
506 struct sctp_paramhdr param_hdr;
507 union sctp_addr daddr;
508 unsigned long sent_at;
510 } __packed sctp_sender_hb_info_t;
513 * RFC 2960 1.3.2 Sequenced Delivery within Streams
515 * The term "stream" is used in SCTP to refer to a sequence of user
516 * messages that are to be delivered to the upper-layer protocol in
517 * order with respect to other messages within the same stream. This is
518 * in contrast to its usage in TCP, where it refers to a sequence of
519 * bytes (in this document a byte is assumed to be eight bits).
522 * This is the structure we use to track both our outbound and inbound
523 * SSN, or Stream Sequence Numbers.
532 struct sctp_stream in;
533 struct sctp_stream out;
537 struct sctp_ssnmap *sctp_ssnmap_new(__u16 in, __u16 out,
539 void sctp_ssnmap_free(struct sctp_ssnmap *map);
540 void sctp_ssnmap_clear(struct sctp_ssnmap *map);
542 /* What is the current SSN number for this stream? */
543 static inline __u16 sctp_ssn_peek(struct sctp_stream *stream, __u16 id)
545 return stream->ssn[id];
548 /* Return the next SSN number for this stream. */
549 static inline __u16 sctp_ssn_next(struct sctp_stream *stream, __u16 id)
551 return stream->ssn[id]++;
554 /* Skip over this ssn and all below. */
555 static inline void sctp_ssn_skip(struct sctp_stream *stream, __u16 id,
558 stream->ssn[id] = ssn+1;
562 * Pointers to address related SCTP functions.
563 * (i.e. things that depend on the address family.)
566 int (*sctp_xmit) (struct sk_buff *skb,
567 struct sctp_transport *);
568 int (*setsockopt) (struct sock *sk,
572 unsigned int optlen);
573 int (*getsockopt) (struct sock *sk,
578 int (*compat_setsockopt) (struct sock *sk,
582 unsigned int optlen);
583 int (*compat_getsockopt) (struct sock *sk,
588 void (*get_dst) (struct sctp_transport *t,
589 union sctp_addr *saddr,
592 void (*get_saddr) (struct sctp_sock *sk,
593 struct sctp_transport *t,
595 void (*copy_addrlist) (struct list_head *,
596 struct net_device *);
597 int (*cmp_addr) (const union sctp_addr *addr1,
598 const union sctp_addr *addr2);
599 void (*addr_copy) (union sctp_addr *dst,
600 union sctp_addr *src);
601 void (*from_skb) (union sctp_addr *,
604 void (*from_sk) (union sctp_addr *,
606 void (*from_addr_param) (union sctp_addr *,
607 union sctp_addr_param *,
608 __be16 port, int iif);
609 int (*to_addr_param) (const union sctp_addr *,
610 union sctp_addr_param *);
611 int (*addr_valid) (union sctp_addr *,
613 const struct sk_buff *);
614 sctp_scope_t (*scope) (union sctp_addr *);
615 void (*inaddr_any) (union sctp_addr *, __be16);
616 int (*is_any) (const union sctp_addr *);
617 int (*available) (union sctp_addr *,
619 int (*skb_iif) (const struct sk_buff *sk);
620 int (*is_ce) (const struct sk_buff *sk);
621 void (*seq_dump_addr)(struct seq_file *seq,
622 union sctp_addr *addr);
623 void (*ecn_capable)(struct sock *sk);
624 __u16 net_header_len;
626 sa_family_t sa_family;
627 struct list_head list;
630 struct sctp_af *sctp_get_af_specific(sa_family_t);
631 int sctp_register_af(struct sctp_af *);
633 /* Protocol family functions. */
635 void (*event_msgname)(struct sctp_ulpevent *, char *, int *);
636 void (*skb_msgname) (struct sk_buff *, char *, int *);
637 int (*af_supported) (sa_family_t, struct sctp_sock *);
638 int (*cmp_addr) (const union sctp_addr *,
639 const union sctp_addr *,
641 int (*bind_verify) (struct sctp_sock *, union sctp_addr *);
642 int (*send_verify) (struct sctp_sock *, union sctp_addr *);
643 int (*supported_addrs)(const struct sctp_sock *, __be16 *);
644 struct sock *(*create_accept_sk) (struct sock *sk,
645 struct sctp_association *asoc);
646 int (*addr_to_user)(struct sctp_sock *sk, union sctp_addr *addr);
647 void (*to_sk_saddr)(union sctp_addr *, struct sock *sk);
648 void (*to_sk_daddr)(union sctp_addr *, struct sock *sk);
653 /* Structure to track chunk fragments that have been acked, but peer
654 * fragments of the same message have not.
656 struct sctp_datamsg {
657 /* Chunks waiting to be submitted to lower layer. */
658 struct list_head chunks;
659 /* Reference counting. */
661 /* When is this message no longer interesting to the peer? */
662 unsigned long expires_at;
663 /* Did the messenge fail to send? */
666 can_abandon:1, /* can chunks from this message can be abandoned. */
667 can_delay; /* should this message be Nagle delayed */
670 struct sctp_datamsg *sctp_datamsg_from_user(struct sctp_association *,
671 struct sctp_sndrcvinfo *,
672 struct msghdr *, int len);
673 void sctp_datamsg_free(struct sctp_datamsg *);
674 void sctp_datamsg_put(struct sctp_datamsg *);
675 void sctp_chunk_fail(struct sctp_chunk *, int error);
676 int sctp_chunk_abandoned(struct sctp_chunk *);
678 /* RFC2960 1.4 Key Terms
680 * o Chunk: A unit of information within an SCTP packet, consisting of
681 * a chunk header and chunk-specific content.
683 * As a matter of convenience, we remember the SCTP common header for
684 * each chunk as well as a few other header pointers...
687 struct list_head list;
691 /* This is our link to the per-transport transmitted list. */
692 struct list_head transmitted_list;
694 /* This field is used by chunks that hold fragmented data.
695 * For the first fragment this is the list that holds the rest of
696 * fragments. For the remaining fragments, this is the link to the
697 * frag_list maintained in the first fragment.
699 struct list_head frag_list;
701 /* This points to the sk_buff containing the actual data. */
704 /* These are the SCTP headers by reverse order in a packet.
705 * Note that some of these may happen more than once. In that
706 * case, we point at the "current" one, whatever that means
707 * for that level of header.
710 /* We point this at the FIRST TLV parameter to chunk_hdr. */
711 union sctp_params param_hdr;
714 struct sctp_datahdr *data_hdr;
715 struct sctp_inithdr *init_hdr;
716 struct sctp_sackhdr *sack_hdr;
717 struct sctp_heartbeathdr *hb_hdr;
718 struct sctp_sender_hb_info *hbs_hdr;
719 struct sctp_shutdownhdr *shutdown_hdr;
720 struct sctp_signed_cookie *cookie_hdr;
721 struct sctp_ecnehdr *ecne_hdr;
722 struct sctp_cwrhdr *ecn_cwr_hdr;
723 struct sctp_errhdr *err_hdr;
724 struct sctp_addiphdr *addip_hdr;
725 struct sctp_fwdtsn_hdr *fwdtsn_hdr;
726 struct sctp_authhdr *auth_hdr;
731 struct sctp_chunkhdr *chunk_hdr;
732 struct sctphdr *sctp_hdr;
734 /* This needs to be recoverable for SCTP_SEND_FAILED events. */
735 struct sctp_sndrcvinfo sinfo;
737 /* Which association does this belong to? */
738 struct sctp_association *asoc;
740 /* What endpoint received this chunk? */
741 struct sctp_ep_common *rcvr;
743 /* We fill this in if we are calculating RTT. */
744 unsigned long sent_at;
746 /* What is the origin IP address for this chunk? */
747 union sctp_addr source;
748 /* Destination address for this chunk. */
749 union sctp_addr dest;
751 /* For outbound message, track all fragments for SEND_FAILED. */
752 struct sctp_datamsg *msg;
754 /* For an inbound chunk, this tells us where it came from.
755 * For an outbound chunk, it tells us where we'd like it to
756 * go. It is NULL if we have no preference.
758 struct sctp_transport *transport;
760 /* SCTP-AUTH: For the special case inbound processing of COOKIE-ECHO
761 * we need save a pointer to the AUTH chunk, since the SCTP-AUTH
762 * spec violates the principle premis that all chunks are processed
765 struct sk_buff *auth_chunk;
767 #define SCTP_CAN_FRTX 0x0
768 #define SCTP_NEED_FRTX 0x1
769 #define SCTP_DONT_FRTX 0x2
770 __u16 rtt_in_progress:1, /* This chunk used for RTT calc? */
771 has_tsn:1, /* Does this chunk have a TSN yet? */
772 has_ssn:1, /* Does this chunk have a SSN yet? */
773 singleton:1, /* Only chunk in the packet? */
774 end_of_packet:1, /* Last chunk in the packet? */
775 ecn_ce_done:1, /* Have we processed the ECN CE bit? */
776 pdiscard:1, /* Discard the whole packet now? */
777 tsn_gap_acked:1, /* Is this chunk acked by a GAP ACK? */
778 data_accepted:1, /* At least 1 chunk accepted */
779 auth:1, /* IN: was auth'ed | OUT: needs auth */
780 has_asconf:1, /* IN: have seen an asconf before */
781 tsn_missing_report:2, /* Data chunk missing counter. */
782 fast_retransmit:2; /* Is this chunk fast retransmitted? */
785 void sctp_chunk_hold(struct sctp_chunk *);
786 void sctp_chunk_put(struct sctp_chunk *);
787 int sctp_user_addto_chunk(struct sctp_chunk *chunk, int off, int len,
789 void sctp_chunk_free(struct sctp_chunk *);
790 void *sctp_addto_chunk(struct sctp_chunk *, int len, const void *data);
791 void *sctp_addto_chunk_fixed(struct sctp_chunk *, int len, const void *data);
792 struct sctp_chunk *sctp_chunkify(struct sk_buff *,
793 const struct sctp_association *,
795 void sctp_init_addrs(struct sctp_chunk *, union sctp_addr *,
797 const union sctp_addr *sctp_source(const struct sctp_chunk *chunk);
800 SCTP_ADDR_NEW, /* new address added to assoc/ep */
801 SCTP_ADDR_SRC, /* address can be used as source */
802 SCTP_ADDR_DEL, /* address about to be deleted */
805 /* This is a structure for holding either an IPv6 or an IPv4 address. */
806 struct sctp_sockaddr_entry {
807 struct list_head list;
814 #define SCTP_ADDRESS_TICK_DELAY 500
816 typedef struct sctp_chunk *(sctp_packet_phandler_t)(struct sctp_association *);
818 /* This structure holds lists of chunks as we are assembling for
822 /* These are the SCTP header values (host order) for the packet. */
824 __u16 destination_port;
827 /* This contains the payload chunks. */
828 struct list_head chunk_list;
830 /* This is the overhead of the sctp and ip headers. */
832 /* This is the total size of all chunks INCLUDING padding. */
835 /* The packet is destined for this transport address.
836 * The function we finally use to pass down to the next lower
837 * layer lives in the transport structure.
839 struct sctp_transport *transport;
841 /* pointer to the auth chunk for this packet */
842 struct sctp_chunk *auth;
844 u8 has_cookie_echo:1, /* This packet contains a COOKIE-ECHO chunk. */
845 has_sack:1, /* This packet contains a SACK chunk. */
846 has_auth:1, /* This packet contains an AUTH chunk */
847 has_data:1, /* This packet contains at least 1 DATA chunk */
848 ipfragok:1, /* So let ip fragment this packet */
849 malloced:1; /* Is it malloced? */
852 struct sctp_packet *sctp_packet_init(struct sctp_packet *,
853 struct sctp_transport *,
854 __u16 sport, __u16 dport);
855 struct sctp_packet *sctp_packet_config(struct sctp_packet *, __u32 vtag, int);
856 sctp_xmit_t sctp_packet_transmit_chunk(struct sctp_packet *,
857 struct sctp_chunk *, int);
858 sctp_xmit_t sctp_packet_append_chunk(struct sctp_packet *,
859 struct sctp_chunk *);
860 int sctp_packet_transmit(struct sctp_packet *);
861 void sctp_packet_free(struct sctp_packet *);
863 static inline int sctp_packet_empty(struct sctp_packet *packet)
865 return packet->size == packet->overhead;
868 /* This represents a remote transport address.
869 * For local transport addresses, we just use union sctp_addr.
871 * RFC2960 Section 1.4 Key Terms
873 * o Transport address: A Transport Address is traditionally defined
874 * by Network Layer address, Transport Layer protocol and Transport
875 * Layer port number. In the case of SCTP running over IP, a
876 * transport address is defined by the combination of an IP address
877 * and an SCTP port number (where SCTP is the Transport protocol).
879 * RFC2960 Section 7.1 SCTP Differences from TCP Congestion control
881 * o The sender keeps a separate congestion control parameter set for
882 * each of the destination addresses it can send to (not each
883 * source-destination pair but for each destination). The parameters
884 * should decay if the address is not used for a long enough time
888 struct sctp_transport {
889 /* A list of transports. */
890 struct list_head transports;
892 /* Reference counting. */
895 /* RTO-Pending : A flag used to track if one of the DATA
896 * chunks sent to this address is currently being
897 * used to compute a RTT. If this flag is 0,
898 * the next DATA chunk sent to this destination
899 * should be used to compute a RTT and this flag
900 * should be set. Every time the RTT
901 * calculation completes (i.e. the DATA chunk
902 * is SACK'd) clear this flag.
907 * hb_sent : a flag that signals that we have a pending
912 /* Is the Path MTU update pending on this tranport */
915 /* Is this structure kfree()able? */
920 /* This is the peer's IP address and port. */
921 union sctp_addr ipaddr;
923 /* These are the functions we call to handle LLP stuff. */
924 struct sctp_af *af_specific;
926 /* Which association do we belong to? */
927 struct sctp_association *asoc;
931 * 12.3 Per Transport Address Data
933 * For each destination transport address in the peer's
934 * address list derived from the INIT or INIT ACK chunk, a
935 * number of data elements needs to be maintained including:
937 /* RTO : The current retransmission timeout value. */
940 __u32 rtt; /* This is the most recent RTT. */
942 /* RTTVAR : The current RTT variation. */
945 /* SRTT : The current smoothed round trip time. */
949 * These are the congestion stats.
951 /* cwnd : The current congestion window. */
952 __u32 cwnd; /* This is the actual cwnd. */
954 /* ssthresh : The current slow start threshold value. */
957 /* partial : The tracking method for increase of cwnd when in
958 * bytes acked : congestion avoidance mode (see Section 6.2.2)
960 __u32 partial_bytes_acked;
962 /* Data that has been sent, but not acknowledged. */
965 __u32 burst_limited; /* Holds old cwnd when max.burst is applied */
968 struct dst_entry *dst;
969 /* Source address. */
970 union sctp_addr saddr;
972 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
973 * the destination address every heartbeat interval.
975 unsigned long hbinterval;
977 /* SACK delay timeout */
978 unsigned long sackdelay;
981 /* When was the last time (in jiffies) that we heard from this
982 * transport? We use this to pick new active and retran paths.
984 unsigned long last_time_heard;
986 /* Last time(in jiffies) when cwnd is reduced due to the congestion
987 * indication based on ECNE chunk.
989 unsigned long last_time_ecne_reduced;
991 /* This is the max_retrans value for the transport and will
992 * be initialized from the assocs value. This can be changed
993 * using SCTP_SET_PEER_ADDR_PARAMS socket option.
997 /* PMTU : The current known path MTU. */
1000 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
1003 /* The number of times INIT has been sent on this transport. */
1004 int init_sent_count;
1006 /* state : The current state of this destination,
1007 * : i.e. SCTP_ACTIVE, SCTP_INACTIVE, SCTP_UNKNOWN.
1011 /* These are the error stats for this destination. */
1013 /* Error count : The current error count for this destination. */
1014 unsigned short error_count;
1016 /* Per : A timer used by each destination.
1020 * [Everywhere else in the text this is called T3-rtx. -ed]
1022 struct timer_list T3_rtx_timer;
1024 /* Heartbeat timer is per destination. */
1025 struct timer_list hb_timer;
1027 /* Timer to handle ICMP proto unreachable envets */
1028 struct timer_list proto_unreach_timer;
1030 /* Since we're using per-destination retransmission timers
1031 * (see above), we're also using per-destination "transmitted"
1032 * queues. This probably ought to be a private struct
1033 * accessible only within the outqueue, but it's not, yet.
1035 struct list_head transmitted;
1037 /* We build bundle-able packets for this transport here. */
1038 struct sctp_packet packet;
1040 /* This is the list of transports that have chunks to send. */
1041 struct list_head send_ready;
1043 /* State information saved for SFR_CACC algorithm. The key
1044 * idea in SFR_CACC is to maintain state at the sender on a
1045 * per-destination basis when a changeover happens.
1046 * char changeover_active;
1047 * char cycling_changeover;
1048 * __u32 next_tsn_at_change;
1049 * char cacc_saw_newack;
1052 /* An unsigned integer, which stores the next TSN to be
1053 * used by the sender, at the moment of changeover.
1055 __u32 next_tsn_at_change;
1057 /* A flag which indicates the occurrence of a changeover */
1058 char changeover_active;
1060 /* A flag which indicates whether the change of primary is
1061 * the first switch to this destination address during an
1064 char cycling_changeover;
1066 /* A temporary flag, which is used during the processing of
1067 * a SACK to estimate the causative TSN(s)'s group.
1069 char cacc_saw_newack;
1072 /* 64-bit random number sent with heartbeat. */
1076 struct sctp_transport *sctp_transport_new(const union sctp_addr *,
1078 void sctp_transport_set_owner(struct sctp_transport *,
1079 struct sctp_association *);
1080 void sctp_transport_route(struct sctp_transport *, union sctp_addr *,
1081 struct sctp_sock *);
1082 void sctp_transport_pmtu(struct sctp_transport *, struct sock *sk);
1083 void sctp_transport_free(struct sctp_transport *);
1084 void sctp_transport_reset_timers(struct sctp_transport *);
1085 void sctp_transport_hold(struct sctp_transport *);
1086 void sctp_transport_put(struct sctp_transport *);
1087 void sctp_transport_update_rto(struct sctp_transport *, __u32);
1088 void sctp_transport_raise_cwnd(struct sctp_transport *, __u32, __u32);
1089 void sctp_transport_lower_cwnd(struct sctp_transport *, sctp_lower_cwnd_t);
1090 void sctp_transport_burst_limited(struct sctp_transport *);
1091 void sctp_transport_burst_reset(struct sctp_transport *);
1092 unsigned long sctp_transport_timeout(struct sctp_transport *);
1093 void sctp_transport_reset(struct sctp_transport *);
1094 void sctp_transport_update_pmtu(struct sctp_transport *, u32);
1097 /* This is the structure we use to queue packets as they come into
1098 * SCTP. We write packets to it and read chunks from it.
1101 /* This is actually a queue of sctp_chunk each
1102 * containing a partially decoded packet.
1104 struct list_head in_chunk_list;
1105 /* This is the packet which is currently off the in queue and is
1106 * being worked on through the inbound chunk processing.
1108 struct sctp_chunk *in_progress;
1110 /* This is the delayed task to finish delivering inbound
1113 struct work_struct immediate;
1115 int malloced; /* Is this structure kfree()able? */
1118 void sctp_inq_init(struct sctp_inq *);
1119 void sctp_inq_free(struct sctp_inq *);
1120 void sctp_inq_push(struct sctp_inq *, struct sctp_chunk *packet);
1121 struct sctp_chunk *sctp_inq_pop(struct sctp_inq *);
1122 struct sctp_chunkhdr *sctp_inq_peek(struct sctp_inq *);
1123 void sctp_inq_set_th_handler(struct sctp_inq *, work_func_t);
1125 /* This is the structure we use to hold outbound chunks. You push
1126 * chunks in and they automatically pop out the other end as bundled
1127 * packets (it calls (*output_handler)()).
1129 * This structure covers sections 6.3, 6.4, 6.7, 6.8, 6.10, 7., 8.1,
1130 * and 8.2 of the v13 draft.
1132 * It handles retransmissions. The connection to the timeout portion
1133 * of the state machine is through sctp_..._timeout() and timeout_handler.
1135 * If you feed it SACKs, it will eat them.
1137 * If you give it big chunks, it will fragment them.
1139 * It assigns TSN's to data chunks. This happens at the last possible
1140 * instant before transmission.
1142 * When free()'d, it empties itself out via output_handler().
1145 struct sctp_association *asoc;
1147 /* Data pending that has never been transmitted. */
1148 struct list_head out_chunk_list;
1150 unsigned out_qlen; /* Total length of queued data chunks. */
1152 /* Error of send failed, may used in SCTP_SEND_FAILED event. */
1155 /* These are control chunks we want to send. */
1156 struct list_head control_chunk_list;
1158 /* These are chunks that have been sacked but are above the
1159 * CTSN, or cumulative tsn ack point.
1161 struct list_head sacked;
1163 /* Put chunks on this list to schedule them for
1166 struct list_head retransmit;
1168 /* Put chunks on this list to save them for FWD TSN processing as
1169 * they were abandoned.
1171 struct list_head abandoned;
1173 /* How many unackd bytes do we have in-flight? */
1174 __u32 outstanding_bytes;
1176 /* Are we doing fast-rtx on this queue */
1182 /* Is this structure empty? */
1185 /* Are we kfree()able? */
1189 void sctp_outq_init(struct sctp_association *, struct sctp_outq *);
1190 void sctp_outq_teardown(struct sctp_outq *);
1191 void sctp_outq_free(struct sctp_outq*);
1192 int sctp_outq_tail(struct sctp_outq *, struct sctp_chunk *chunk);
1193 int sctp_outq_sack(struct sctp_outq *, struct sctp_sackhdr *);
1194 int sctp_outq_is_empty(const struct sctp_outq *);
1195 void sctp_outq_restart(struct sctp_outq *);
1197 void sctp_retransmit(struct sctp_outq *, struct sctp_transport *,
1198 sctp_retransmit_reason_t);
1199 void sctp_retransmit_mark(struct sctp_outq *, struct sctp_transport *, __u8);
1200 int sctp_outq_uncork(struct sctp_outq *);
1201 /* Uncork and flush an outqueue. */
1202 static inline void sctp_outq_cork(struct sctp_outq *q)
1207 /* These bind address data fields common between endpoints and associations */
1208 struct sctp_bind_addr {
1210 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1212 * SCTP Port: The local SCTP port number the endpoint is
1217 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1219 * Address List: The list of IP addresses that this instance
1220 * has bound. This information is passed to one's
1221 * peer(s) in INIT and INIT ACK chunks.
1223 struct list_head address_list;
1225 int malloced; /* Are we kfree()able? */
1228 void sctp_bind_addr_init(struct sctp_bind_addr *, __u16 port);
1229 void sctp_bind_addr_free(struct sctp_bind_addr *);
1230 int sctp_bind_addr_copy(struct sctp_bind_addr *dest,
1231 const struct sctp_bind_addr *src,
1232 sctp_scope_t scope, gfp_t gfp,
1234 int sctp_bind_addr_dup(struct sctp_bind_addr *dest,
1235 const struct sctp_bind_addr *src,
1237 int sctp_add_bind_addr(struct sctp_bind_addr *, union sctp_addr *,
1238 __u8 addr_state, gfp_t gfp);
1239 int sctp_del_bind_addr(struct sctp_bind_addr *, union sctp_addr *);
1240 int sctp_bind_addr_match(struct sctp_bind_addr *, const union sctp_addr *,
1241 struct sctp_sock *);
1242 int sctp_bind_addr_conflict(struct sctp_bind_addr *, const union sctp_addr *,
1243 struct sctp_sock *, struct sctp_sock *);
1244 int sctp_bind_addr_state(const struct sctp_bind_addr *bp,
1245 const union sctp_addr *addr);
1246 union sctp_addr *sctp_find_unmatch_addr(struct sctp_bind_addr *bp,
1247 const union sctp_addr *addrs,
1249 struct sctp_sock *opt);
1250 union sctp_params sctp_bind_addrs_to_raw(const struct sctp_bind_addr *bp,
1253 int sctp_raw_to_bind_addrs(struct sctp_bind_addr *bp, __u8 *raw, int len,
1254 __u16 port, gfp_t gfp);
1256 sctp_scope_t sctp_scope(const union sctp_addr *);
1257 int sctp_in_scope(const union sctp_addr *addr, const sctp_scope_t scope);
1258 int sctp_is_any(struct sock *sk, const union sctp_addr *addr);
1259 int sctp_addr_is_valid(const union sctp_addr *addr);
1260 int sctp_is_ep_boundall(struct sock *sk);
1263 /* What type of endpoint? */
1265 SCTP_EP_TYPE_SOCKET,
1266 SCTP_EP_TYPE_ASSOCIATION,
1267 } sctp_endpoint_type_t;
1270 * A common base class to bridge the implmentation view of a
1271 * socket (usually listening) endpoint versus an association's
1273 * This common structure is useful for several purposes:
1274 * 1) Common interface for lookup routines.
1275 * a) Subfunctions work for either endpoint or association
1276 * b) Single interface to lookup allows hiding the lookup lock rather
1277 * than acquiring it externally.
1278 * 2) Common interface for the inbound chunk handling/state machine.
1279 * 3) Common object handling routines for reference counting, etc.
1280 * 4) Disentangle association lookup from endpoint lookup, where we
1281 * do not have to find our endpoint to find our association.
1285 struct sctp_ep_common {
1286 /* Fields to help us manage our entries in the hash tables. */
1287 struct hlist_node node;
1290 /* Runtime type information. What kind of endpoint is this? */
1291 sctp_endpoint_type_t type;
1293 /* Some fields to help us manage this object.
1294 * refcnt - Reference count access to this object.
1295 * dead - Do not attempt to use this object.
1296 * malloced - Do we need to kfree this object?
1302 /* What socket does this endpoint belong to? */
1305 /* This is where we receive inbound chunks. */
1306 struct sctp_inq inqueue;
1308 /* This substructure includes the defining parameters of the
1310 * bind_addr.port is our shared port number.
1311 * bind_addr.address_list is our set of local IP addresses.
1313 struct sctp_bind_addr bind_addr;
1317 /* RFC Section 1.4 Key Terms
1319 * o SCTP endpoint: The logical sender/receiver of SCTP packets. On a
1320 * multi-homed host, an SCTP endpoint is represented to its peers as a
1321 * combination of a set of eligible destination transport addresses to
1322 * which SCTP packets can be sent and a set of eligible source
1323 * transport addresses from which SCTP packets can be received.
1324 * All transport addresses used by an SCTP endpoint must use the
1325 * same port number, but can use multiple IP addresses. A transport
1326 * address used by an SCTP endpoint must not be used by another
1327 * SCTP endpoint. In other words, a transport address is unique
1328 * to an SCTP endpoint.
1330 * From an implementation perspective, each socket has one of these.
1331 * A TCP-style socket will have exactly one association on one of
1332 * these. An UDP-style socket will have multiple associations hanging
1336 struct sctp_endpoint {
1337 /* Common substructure for endpoint and association. */
1338 struct sctp_ep_common base;
1340 /* Associations: A list of current associations and mappings
1341 * to the data consumers for each association. This
1342 * may be in the form of a hash table or other
1343 * implementation dependent structure. The data
1344 * consumers may be process identification
1345 * information such as file descriptors, named pipe
1346 * pointer, or table pointers dependent on how SCTP
1349 /* This is really a list of struct sctp_association entries. */
1350 struct list_head asocs;
1352 /* Secret Key: A secret key used by this endpoint to compute
1353 * the MAC. This SHOULD be a cryptographic quality
1354 * random number with a sufficient length.
1355 * Discussion in [RFC1750] can be helpful in
1356 * selection of the key.
1358 __u8 secret_key[SCTP_HOW_MANY_SECRETS][SCTP_SECRET_SIZE];
1363 /* digest: This is a digest of the sctp cookie. This field is
1364 * only used on the receive path when we try to validate
1365 * that the cookie has not been tampered with. We put
1366 * this here so we pre-allocate this once and can re-use
1371 /* sendbuf acct. policy. */
1372 __u32 sndbuf_policy;
1374 /* rcvbuf acct. policy. */
1375 __u32 rcvbuf_policy;
1377 /* SCTP AUTH: array of the HMACs that will be allocated
1378 * we need this per association so that we don't serialize
1380 struct crypto_hash **auth_hmacs;
1382 /* SCTP-AUTH: hmacs for the endpoint encoded into parameter */
1383 struct sctp_hmac_algo_param *auth_hmacs_list;
1385 /* SCTP-AUTH: chunks to authenticate encoded into parameter */
1386 struct sctp_chunks_param *auth_chunk_list;
1388 /* SCTP-AUTH: endpoint shared keys */
1389 struct list_head endpoint_shared_keys;
1390 __u16 active_key_id;
1393 /* Recover the outter endpoint structure. */
1394 static inline struct sctp_endpoint *sctp_ep(struct sctp_ep_common *base)
1396 struct sctp_endpoint *ep;
1398 ep = container_of(base, struct sctp_endpoint, base);
1402 /* These are function signatures for manipulating endpoints. */
1403 struct sctp_endpoint *sctp_endpoint_new(struct sock *, gfp_t);
1404 void sctp_endpoint_free(struct sctp_endpoint *);
1405 void sctp_endpoint_put(struct sctp_endpoint *);
1406 void sctp_endpoint_hold(struct sctp_endpoint *);
1407 void sctp_endpoint_add_asoc(struct sctp_endpoint *, struct sctp_association *);
1408 struct sctp_association *sctp_endpoint_lookup_assoc(
1409 const struct sctp_endpoint *ep,
1410 const union sctp_addr *paddr,
1411 struct sctp_transport **);
1412 int sctp_endpoint_is_peeled_off(struct sctp_endpoint *,
1413 const union sctp_addr *);
1414 struct sctp_endpoint *sctp_endpoint_is_match(struct sctp_endpoint *,
1415 const union sctp_addr *);
1416 int sctp_has_association(const union sctp_addr *laddr,
1417 const union sctp_addr *paddr);
1419 int sctp_verify_init(const struct sctp_association *asoc, sctp_cid_t,
1420 sctp_init_chunk_t *peer_init, struct sctp_chunk *chunk,
1421 struct sctp_chunk **err_chunk);
1422 int sctp_process_init(struct sctp_association *, struct sctp_chunk *chunk,
1423 const union sctp_addr *peer,
1424 sctp_init_chunk_t *init, gfp_t gfp);
1425 __u32 sctp_generate_tag(const struct sctp_endpoint *);
1426 __u32 sctp_generate_tsn(const struct sctp_endpoint *);
1428 struct sctp_inithdr_host {
1431 __u16 num_outbound_streams;
1432 __u16 num_inbound_streams;
1438 * 12. Recommended Transmission Control Block (TCB) Parameters
1440 * This section details a recommended set of parameters that should
1441 * be contained within the TCB for an implementation. This section is
1442 * for illustrative purposes and should not be deemed as requirements
1443 * on an implementation or as an exhaustive list of all parameters
1444 * inside an SCTP TCB. Each implementation may need its own additional
1445 * parameters for optimization.
1449 /* Here we have information about each individual association. */
1450 struct sctp_association {
1452 /* A base structure common to endpoint and association.
1453 * In this context, it represents the associations's view
1454 * of the local endpoint of the association.
1456 struct sctp_ep_common base;
1458 /* Associations on the same socket. */
1459 struct list_head asocs;
1461 /* association id. */
1462 sctp_assoc_t assoc_id;
1464 /* This is our parent endpoint. */
1465 struct sctp_endpoint *ep;
1467 /* These are those association elements needed in the cookie. */
1468 struct sctp_cookie c;
1470 /* This is all information about our peer. */
1474 * Peer Rwnd : Current calculated value of the peer's rwnd.
1478 /* transport_addr_list
1480 * Peer : A list of SCTP transport addresses that the
1481 * Transport : peer is bound to. This information is derived
1482 * Address : from the INIT or INIT ACK and is used to
1483 * List : associate an inbound packet with a given
1484 * : association. Normally this information is
1485 * : hashed or keyed for quick lookup and access
1487 * : The list is also initialized with the list
1488 * : of addresses passed with the sctp_connectx()
1491 * It is a list of SCTP_transport's.
1493 struct list_head transport_addr_list;
1497 * Peer : A count of the number of peer addresses
1498 * Transport : in the Peer Transport Address List.
1502 __u16 transport_count;
1505 * The transport layer port number.
1511 * Primary : This is the current primary destination
1512 * Path : transport address of the peer endpoint. It
1513 * : may also specify a source transport address
1514 * : on this endpoint.
1516 * All of these paths live on transport_addr_list.
1518 * At the bakeoffs, we discovered that the intent of
1519 * primaryPath is that it only changes when the ULP
1520 * asks to have it changed. We add the activePath to
1521 * designate the connection we are currently using to
1522 * transmit new data and most control chunks.
1524 struct sctp_transport *primary_path;
1526 /* Cache the primary path address here, when we
1527 * need a an address for msg_name.
1529 union sctp_addr primary_addr;
1532 * The path that we are currently using to
1533 * transmit new data and most control chunks.
1535 struct sctp_transport *active_path;
1539 * RFC2960 6.4 Multi-homed SCTP Endpoints
1541 * Furthermore, when its peer is multi-homed, an
1542 * endpoint SHOULD try to retransmit a chunk to an
1543 * active destination transport address that is
1544 * different from the last destination address to
1545 * which the DATA chunk was sent.
1547 struct sctp_transport *retran_path;
1549 /* Pointer to last transport I have sent on. */
1550 struct sctp_transport *last_sent_to;
1552 /* This is the last transport I have received DATA on. */
1553 struct sctp_transport *last_data_from;
1556 * Mapping An array of bits or bytes indicating which out of
1557 * Array order TSN's have been received (relative to the
1558 * Last Rcvd TSN). If no gaps exist, i.e. no out of
1559 * order packets have been received, this array
1560 * will be set to all zero. This structure may be
1561 * in the form of a circular buffer or bit array.
1563 * Last Rcvd : This is the last TSN received in
1564 * TSN : sequence. This value is set initially by
1565 * : taking the peer's Initial TSN, received in
1566 * : the INIT or INIT ACK chunk, and subtracting
1569 * Throughout most of the specification this is called the
1570 * "Cumulative TSN ACK Point". In this case, we
1571 * ignore the advice in 12.2 in favour of the term
1572 * used in the bulk of the text. This value is hidden
1573 * in tsn_map--we get it by calling sctp_tsnmap_get_ctsn().
1575 struct sctp_tsnmap tsn_map;
1577 /* Ack State : This flag indicates if the next received
1578 * : packet is to be responded to with a
1579 * : SACK. This is initializedto 0. When a packet
1580 * : is received it is incremented. If this value
1581 * : reaches 2 or more, a SACK is sent and the
1582 * : value is reset to 0. Note: This is used only
1583 * : when no DATA chunks are received out of
1584 * : order. When DATA chunks are out of order,
1585 * : SACK's are not delayed (see Section 6).
1587 __u8 sack_needed:1, /* Do we need to sack the peer? */
1588 zero_window_announced:1;
1591 /* These are capabilities which our peer advertised. */
1592 __u8 ecn_capable:1, /* Can peer do ECN? */
1593 ipv4_address:1, /* Peer understands IPv4 addresses? */
1594 ipv6_address:1, /* Peer understands IPv6 addresses? */
1595 hostname_address:1, /* Peer understands DNS addresses? */
1596 asconf_capable:1, /* Does peer support ADDIP? */
1597 prsctp_capable:1, /* Can peer do PR-SCTP? */
1598 auth_capable:1; /* Is peer doing SCTP-AUTH? */
1600 __u32 adaptation_ind; /* Adaptation Code point. */
1602 /* This mask is used to disable sending the ASCONF chunk
1603 * with specified parameter to peer.
1605 __be16 addip_disabled_mask;
1607 struct sctp_inithdr_host i;
1611 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
1612 * C1) ... "Peer-Serial-Number'. This value MUST be initialized to the
1613 * Initial TSN Value minus 1
1617 /* SCTP-AUTH: We need to know pears random number, hmac list
1618 * and authenticated chunk list. All that is part of the
1619 * cookie and these are just pointers to those locations
1621 sctp_random_param_t *peer_random;
1622 sctp_chunks_param_t *peer_chunks;
1623 sctp_hmac_algo_param_t *peer_hmacs;
1626 /* State : A state variable indicating what state the
1627 * : association is in, i.e. COOKIE-WAIT,
1628 * : COOKIE-ECHOED, ESTABLISHED, SHUTDOWN-PENDING,
1629 * : SHUTDOWN-SENT, SHUTDOWN-RECEIVED, SHUTDOWN-ACK-SENT.
1631 * Note: No "CLOSED" state is illustrated since if a
1632 * association is "CLOSED" its TCB SHOULD be removed.
1634 * In this implementation we DO have a CLOSED
1635 * state which is used during initiation and shutdown.
1637 * State takes values from SCTP_STATE_*.
1641 /* The cookie life I award for any cookie. */
1642 struct timeval cookie_life;
1644 /* Overall : The overall association error count.
1645 * Error Count : [Clear this any time I get something.]
1647 int overall_error_count;
1649 /* These are the association's initial, max, and min RTO values.
1650 * These values will be initialized by system defaults, but can
1651 * be modified via the SCTP_RTOINFO socket option.
1653 unsigned long rto_initial;
1654 unsigned long rto_max;
1655 unsigned long rto_min;
1657 /* Maximum number of new data packets that can be sent in a burst. */
1660 /* This is the max_retrans value for the association. This value will
1661 * be initialized initialized from system defaults, but can be
1662 * modified by the SCTP_ASSOCINFO socket option.
1666 /* Maximum number of times the endpoint will retransmit INIT */
1667 __u16 max_init_attempts;
1669 /* How many times have we resent an INIT? */
1672 /* The largest timeout or RTO value to use in attempting an INIT */
1673 unsigned long max_init_timeo;
1675 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
1676 * the destination address every heartbeat interval. This value
1677 * will be inherited by all new transports.
1679 unsigned long hbinterval;
1681 /* This is the max_retrans value for new transports in the
1686 /* Flag that path mtu update is pending */
1689 /* Association : The smallest PMTU discovered for all of the
1690 * PMTU : peer's transport addresses.
1694 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
1697 /* SACK delay timeout */
1698 unsigned long sackdelay;
1702 unsigned long timeouts[SCTP_NUM_TIMEOUT_TYPES];
1703 struct timer_list timers[SCTP_NUM_TIMEOUT_TYPES];
1705 /* Transport to which SHUTDOWN chunk was last sent. */
1706 struct sctp_transport *shutdown_last_sent_to;
1708 /* How many times have we resent a SHUTDOWN */
1709 int shutdown_retries;
1711 /* Transport to which INIT chunk was last sent. */
1712 struct sctp_transport *init_last_sent_to;
1714 /* Next TSN : The next TSN number to be assigned to a new
1715 * : DATA chunk. This is sent in the INIT or INIT
1716 * : ACK chunk to the peer and incremented each
1717 * : time a DATA chunk is assigned a TSN
1718 * : (normally just prior to transmit or during
1724 * Last Rcvd : This is the last TSN received in sequence. This value
1725 * TSN : is set initially by taking the peer's Initial TSN,
1726 * : received in the INIT or INIT ACK chunk, and
1727 * : subtracting one from it.
1729 * Most of RFC 2960 refers to this as the Cumulative TSN Ack Point.
1732 __u32 ctsn_ack_point;
1734 /* PR-SCTP Advanced.Peer.Ack.Point */
1735 __u32 adv_peer_ack_point;
1737 /* Highest TSN that is acknowledged by incoming SACKs. */
1738 __u32 highest_sacked;
1740 /* TSN marking the fast recovery exit point */
1741 __u32 fast_recovery_exit;
1743 /* Flag to track the current fast recovery state */
1746 /* The number of unacknowledged data chunks. Reported through
1747 * the SCTP_STATUS sockopt.
1751 /* The total number of data chunks that we've had to retransmit
1752 * as the result of a T3 timer expiration
1754 __u32 rtx_data_chunks;
1756 /* This is the association's receive buffer space. This value is used
1757 * to set a_rwnd field in an INIT or a SACK chunk.
1761 /* This is the last advertised value of rwnd over a SACK chunk. */
1764 /* Number of bytes by which the rwnd has slopped. The rwnd is allowed
1765 * to slop over a maximum of the association's frag_point.
1769 /* Keeps treack of rwnd pressure. This happens when we have
1770 * a window, but not recevie buffer (i.e small packets). This one
1771 * is releases slowly (1 PMTU at a time ).
1775 /* This is the sndbuf size in use for the association.
1776 * This corresponds to the sndbuf size for the association,
1777 * as specified in the sk->sndbuf.
1781 /* This is the amount of memory that this association has allocated
1782 * in the receive path at any given time.
1784 atomic_t rmem_alloc;
1786 /* This is the wait queue head for send requests waiting on
1787 * the association sndbuf space.
1789 wait_queue_head_t wait;
1791 /* The message size at which SCTP fragmentation will occur. */
1795 /* Counter used to count INIT errors. */
1796 int init_err_counter;
1798 /* Count the number of INIT cycles (for doubling timeout). */
1801 /* Default send parameters. */
1802 __u16 default_stream;
1803 __u16 default_flags;
1805 __u32 default_context;
1806 __u32 default_timetolive;
1808 /* Default receive parameters */
1809 __u32 default_rcv_context;
1811 /* This tracks outbound ssn for a given stream. */
1812 struct sctp_ssnmap *ssnmap;
1814 /* All outbound chunks go through this structure. */
1815 struct sctp_outq outqueue;
1817 /* A smart pipe that will handle reordering and fragmentation,
1818 * as well as handle passing events up to the ULP.
1820 struct sctp_ulpq ulpq;
1822 /* Last TSN that caused an ECNE Chunk to be sent. */
1823 __u32 last_ecne_tsn;
1825 /* Last TSN that caused a CWR Chunk to be sent. */
1828 /* How many duplicated TSNs have we seen? */
1831 /* Number of seconds of idle time before an association is closed.
1832 * In the association context, this is really used as a boolean
1833 * since the real timeout is stored in the timeouts array
1837 /* These are to support
1838 * "SCTP Extensions for Dynamic Reconfiguration of IP Addresses
1839 * and Enforcement of Flow and Message Limits"
1840 * <draft-ietf-tsvwg-addip-sctp-02.txt>
1841 * or "ADDIP" for short.
1846 /* ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1848 * R1) One and only one ASCONF Chunk MAY be in transit and
1849 * unacknowledged at any one time. If a sender, after sending
1850 * an ASCONF chunk, decides it needs to transfer another
1851 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1852 * returns from the previous ASCONF Chunk before sending a
1853 * subsequent ASCONF. Note this restriction binds each side,
1854 * so at any time two ASCONF may be in-transit on any given
1855 * association (one sent from each endpoint).
1857 * [This is our one-and-only-one ASCONF in flight. If we do
1858 * not have an ASCONF in flight, this is NULL.]
1860 struct sctp_chunk *addip_last_asconf;
1862 /* ADDIP Section 5.2 Upon reception of an ASCONF Chunk.
1864 * This is needed to implement itmes E1 - E4 of the updated
1865 * spec. Here is the justification:
1867 * Since the peer may bundle multiple ASCONF chunks toward us,
1868 * we now need the ability to cache multiple ACKs. The section
1869 * describes in detail how they are cached and cleaned up.
1871 struct list_head asconf_ack_list;
1873 /* These ASCONF chunks are waiting to be sent.
1875 * These chunaks can't be pushed to outqueue until receiving
1876 * ASCONF_ACK for the previous ASCONF indicated by
1877 * addip_last_asconf, so as to guarantee that only one ASCONF
1878 * is in flight at any time.
1880 * ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1882 * In defining the ASCONF Chunk transfer procedures, it is
1883 * essential that these transfers MUST NOT cause congestion
1884 * within the network. To achieve this, we place these
1885 * restrictions on the transfer of ASCONF Chunks:
1887 * R1) One and only one ASCONF Chunk MAY be in transit and
1888 * unacknowledged at any one time. If a sender, after sending
1889 * an ASCONF chunk, decides it needs to transfer another
1890 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1891 * returns from the previous ASCONF Chunk before sending a
1892 * subsequent ASCONF. Note this restriction binds each side,
1893 * so at any time two ASCONF may be in-transit on any given
1894 * association (one sent from each endpoint).
1897 * [I really think this is EXACTLY the sort of intelligence
1898 * which already resides in sctp_outq. Please move this
1899 * queue and its supporting logic down there. --piggy]
1901 struct list_head addip_chunk_list;
1903 /* ADDIP Section 4.1 ASCONF Chunk Procedures
1905 * A2) A serial number should be assigned to the Chunk. The
1906 * serial number SHOULD be a monotonically increasing
1907 * number. The serial number SHOULD be initialized at
1908 * the start of the association to the same value as the
1909 * Initial TSN and every time a new ASCONF chunk is created
1910 * it is incremented by one after assigning the serial number
1911 * to the newly created chunk.
1914 * 3.1.1 Address/Stream Configuration Change Chunk (ASCONF)
1916 * Serial Number : 32 bits (unsigned integer)
1918 * This value represents a Serial Number for the ASCONF
1919 * Chunk. The valid range of Serial Number is from 0 to
1920 * 4294967295 (2^32 - 1). Serial Numbers wrap back to 0
1921 * after reaching 4294967295.
1924 union sctp_addr *asconf_addr_del_pending;
1925 int src_out_of_asoc_ok;
1926 struct sctp_transport *new_transport;
1928 /* SCTP AUTH: list of the endpoint shared keys. These
1929 * keys are provided out of band by the user applicaton
1930 * and can't change during the lifetime of the association
1932 struct list_head endpoint_shared_keys;
1935 * The current generated assocaition shared key (secret)
1937 struct sctp_auth_bytes *asoc_shared_key;
1939 /* SCTP AUTH: hmac id of the first peer requested algorithm
1942 __u16 default_hmac_id;
1944 __u16 active_key_id;
1946 __u8 need_ecne:1, /* Need to send an ECNE Chunk? */
1947 temp:1; /* Is it a temporary association? */
1951 /* An eyecatcher for determining if we are really looking at an
1952 * association data structure.
1955 SCTP_ASSOC_EYECATCHER = 0xa550c123,
1958 /* Recover the outter association structure. */
1959 static inline struct sctp_association *sctp_assoc(struct sctp_ep_common *base)
1961 struct sctp_association *asoc;
1963 asoc = container_of(base, struct sctp_association, base);
1967 /* These are function signatures for manipulating associations. */
1970 struct sctp_association *
1971 sctp_association_new(const struct sctp_endpoint *, const struct sock *,
1972 sctp_scope_t scope, gfp_t gfp);
1973 void sctp_association_free(struct sctp_association *);
1974 void sctp_association_put(struct sctp_association *);
1975 void sctp_association_hold(struct sctp_association *);
1977 struct sctp_transport *sctp_assoc_choose_alter_transport(
1978 struct sctp_association *, struct sctp_transport *);
1979 void sctp_assoc_update_retran_path(struct sctp_association *);
1980 struct sctp_transport *sctp_assoc_lookup_paddr(const struct sctp_association *,
1981 const union sctp_addr *);
1982 int sctp_assoc_lookup_laddr(struct sctp_association *asoc,
1983 const union sctp_addr *laddr);
1984 struct sctp_transport *sctp_assoc_add_peer(struct sctp_association *,
1985 const union sctp_addr *address,
1987 const int peer_state);
1988 void sctp_assoc_del_peer(struct sctp_association *asoc,
1989 const union sctp_addr *addr);
1990 void sctp_assoc_rm_peer(struct sctp_association *asoc,
1991 struct sctp_transport *peer);
1992 void sctp_assoc_control_transport(struct sctp_association *,
1993 struct sctp_transport *,
1994 sctp_transport_cmd_t, sctp_sn_error_t);
1995 struct sctp_transport *sctp_assoc_lookup_tsn(struct sctp_association *, __u32);
1996 struct sctp_transport *sctp_assoc_is_match(struct sctp_association *,
1997 const union sctp_addr *,
1998 const union sctp_addr *);
1999 void sctp_assoc_migrate(struct sctp_association *, struct sock *);
2000 void sctp_assoc_update(struct sctp_association *old,
2001 struct sctp_association *new);
2003 __u32 sctp_association_get_next_tsn(struct sctp_association *);
2005 void sctp_assoc_sync_pmtu(struct sctp_association *);
2006 void sctp_assoc_rwnd_increase(struct sctp_association *, unsigned);
2007 void sctp_assoc_rwnd_decrease(struct sctp_association *, unsigned);
2008 void sctp_assoc_set_primary(struct sctp_association *,
2009 struct sctp_transport *);
2010 void sctp_assoc_del_nonprimary_peers(struct sctp_association *,
2011 struct sctp_transport *);
2012 int sctp_assoc_set_bind_addr_from_ep(struct sctp_association *,
2013 sctp_scope_t, gfp_t);
2014 int sctp_assoc_set_bind_addr_from_cookie(struct sctp_association *,
2015 struct sctp_cookie*,
2017 int sctp_assoc_set_id(struct sctp_association *, gfp_t);
2018 void sctp_assoc_clean_asconf_ack_cache(const struct sctp_association *asoc);
2019 struct sctp_chunk *sctp_assoc_lookup_asconf_ack(
2020 const struct sctp_association *asoc,
2022 void sctp_asconf_queue_teardown(struct sctp_association *asoc);
2024 int sctp_cmp_addr_exact(const union sctp_addr *ss1,
2025 const union sctp_addr *ss2);
2026 struct sctp_chunk *sctp_get_ecne_prepend(struct sctp_association *asoc);
2028 /* A convenience structure to parse out SCTP specific CMSGs. */
2029 typedef struct sctp_cmsgs {
2030 struct sctp_initmsg *init;
2031 struct sctp_sndrcvinfo *info;
2034 /* Structure for tracking memory objects */
2038 } sctp_dbg_objcnt_entry_t;
2040 #endif /* __sctp_structs_h__ */