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. */
68 /* A convenience structure for handling sockaddr structures.
69 * We should wean ourselves off this.
72 struct sockaddr_in v4
;
73 struct sockaddr_in6 v6
;
77 /* Forward declarations for data structures. */
80 struct sctp_association
;
81 struct sctp_transport
;
86 struct sctp_bind_addr
;
88 struct sctp_ep_common
;
92 #include <net/sctp/tsnmap.h>
93 #include <net/sctp/ulpevent.h>
94 #include <net/sctp/ulpqueue.h>
96 /* Structures useful for managing bind/connect. */
98 struct sctp_bind_bucket
{
100 unsigned short fastreuse
;
101 struct sctp_bind_bucket
*next
;
102 struct sctp_bind_bucket
**pprev
;
103 struct hlist_head owner
;
106 struct sctp_bind_hashbucket
{
108 struct sctp_bind_bucket
*chain
;
111 /* Used for hashing all associations. */
112 struct sctp_hashbucket
{
114 struct sctp_ep_common
*chain
;
115 } __attribute__((__aligned__(8)));
118 /* The SCTP globals structure. */
119 extern struct sctp_globals
{
120 /* RFC2960 Section 14. Suggested SCTP Protocol Parameter Values
122 * The following protocol parameters are RECOMMENDED:
124 * RTO.Initial - 3 seconds
126 * RTO.Max - 60 seconds
127 * RTO.Alpha - 1/8 (3 when converted to right shifts.)
128 * RTO.Beta - 1/4 (2 when converted to right shifts.)
130 unsigned long rto_initial
;
131 unsigned long rto_min
;
132 unsigned long rto_max
;
134 /* Note: rto_alpha and rto_beta are really defined as inverse
135 * powers of two to facilitate integer operations.
143 /* Whether Cookie Preservative is enabled(1) or not(0) */
144 int cookie_preserve_enable
;
146 /* Valid.Cookie.Life - 60 seconds */
147 unsigned long valid_cookie_life
;
149 /* Delayed SACK timeout 200ms default*/
150 unsigned long sack_timeout
;
152 /* HB.interval - 30 seconds */
153 unsigned long hb_interval
;
155 /* Association.Max.Retrans - 10 attempts
156 * Path.Max.Retrans - 5 attempts (per destination address)
157 * Max.Init.Retransmits - 8 attempts
159 int max_retrans_association
;
160 int max_retrans_path
;
161 int max_retrans_init
;
164 * Policy for preforming sctp/socket accounting
165 * 0 - do socket level accounting, all assocs share sk_sndbuf
166 * 1 - do sctp accounting, each asoc may use sk_sndbuf bytes
171 * Policy for preforming sctp/socket accounting
172 * 0 - do socket level accounting, all assocs share sk_rcvbuf
173 * 1 - do sctp accounting, each asoc may use sk_rcvbuf bytes
177 /* The following variables are implementation specific. */
179 /* Default initialization values to be applied to new associations. */
181 __u16 max_outstreams
;
183 /* This is a list of groups of functions for each address
184 * family that we support.
186 struct list_head address_families
;
188 /* This is the hash of all endpoints. */
190 struct sctp_hashbucket
*ep_hashtable
;
192 /* This is the hash of all associations. */
194 struct sctp_hashbucket
*assoc_hashtable
;
196 /* This is the sctp port control hash. */
199 spinlock_t port_alloc_lock
; /* Protects port_rover. */
200 struct sctp_bind_hashbucket
*port_hashtable
;
202 /* This is the global local address list.
203 * We actively maintain this complete list of interfaces on
204 * the system by catching routing events.
206 * It is a list of sctp_sockaddr_entry.
208 struct list_head local_addr_list
;
209 spinlock_t local_addr_lock
;
211 /* Flag to indicate if addip is enabled. */
214 /* Flag to indicate if PR-SCTP is enabled. */
218 #define sctp_rto_initial (sctp_globals.rto_initial)
219 #define sctp_rto_min (sctp_globals.rto_min)
220 #define sctp_rto_max (sctp_globals.rto_max)
221 #define sctp_rto_alpha (sctp_globals.rto_alpha)
222 #define sctp_rto_beta (sctp_globals.rto_beta)
223 #define sctp_max_burst (sctp_globals.max_burst)
224 #define sctp_valid_cookie_life (sctp_globals.valid_cookie_life)
225 #define sctp_cookie_preserve_enable (sctp_globals.cookie_preserve_enable)
226 #define sctp_max_retrans_association (sctp_globals.max_retrans_association)
227 #define sctp_sndbuf_policy (sctp_globals.sndbuf_policy)
228 #define sctp_rcvbuf_policy (sctp_globals.rcvbuf_policy)
229 #define sctp_max_retrans_path (sctp_globals.max_retrans_path)
230 #define sctp_max_retrans_init (sctp_globals.max_retrans_init)
231 #define sctp_sack_timeout (sctp_globals.sack_timeout)
232 #define sctp_hb_interval (sctp_globals.hb_interval)
233 #define sctp_max_instreams (sctp_globals.max_instreams)
234 #define sctp_max_outstreams (sctp_globals.max_outstreams)
235 #define sctp_address_families (sctp_globals.address_families)
236 #define sctp_ep_hashsize (sctp_globals.ep_hashsize)
237 #define sctp_ep_hashtable (sctp_globals.ep_hashtable)
238 #define sctp_assoc_hashsize (sctp_globals.assoc_hashsize)
239 #define sctp_assoc_hashtable (sctp_globals.assoc_hashtable)
240 #define sctp_port_hashsize (sctp_globals.port_hashsize)
241 #define sctp_port_rover (sctp_globals.port_rover)
242 #define sctp_port_alloc_lock (sctp_globals.port_alloc_lock)
243 #define sctp_port_hashtable (sctp_globals.port_hashtable)
244 #define sctp_local_addr_list (sctp_globals.local_addr_list)
245 #define sctp_local_addr_lock (sctp_globals.local_addr_lock)
246 #define sctp_addip_enable (sctp_globals.addip_enable)
247 #define sctp_prsctp_enable (sctp_globals.prsctp_enable)
249 /* SCTP Socket type: UDP or TCP style. */
252 SCTP_SOCKET_UDP_HIGH_BANDWIDTH
,
254 } sctp_socket_type_t
;
256 /* Per socket SCTP information. */
258 /* inet_sock has to be the first member of sctp_sock */
259 struct inet_sock inet
;
260 /* What kind of a socket is this? */
261 sctp_socket_type_t type
;
263 /* PF_ family specific functions. */
266 /* Access to HMAC transform. */
267 struct crypto_tfm
*hmac
;
269 /* What is our base endpointer? */
270 struct sctp_endpoint
*ep
;
272 struct sctp_bind_bucket
*bind_hash
;
273 /* Various Socket Options. */
274 __u16 default_stream
;
277 __u32 default_context
;
278 __u32 default_timetolive
;
280 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
281 * the destination address every heartbeat interval. This value
282 * will be inherited by all new associations.
286 /* This is the max_retrans value for new associations. */
289 /* The initial Path MTU to use for new associations. */
292 /* The default SACK delay timeout for new associations. */
295 /* Flags controling Heartbeat, SACK delay, and Path MTU Discovery. */
298 struct sctp_initmsg initmsg
;
299 struct sctp_rtoinfo rtoinfo
;
300 struct sctp_paddrparams paddrparam
;
301 struct sctp_event_subscribe subscribe
;
302 struct sctp_assocparams assocparams
;
306 __u8 disable_fragments
;
311 /* Receive to here while partial delivery is in effect. */
312 struct sk_buff_head pd_lobby
;
315 static inline struct sctp_sock
*sctp_sk(const struct sock
*sk
)
317 return (struct sctp_sock
*)sk
;
320 static inline struct sock
*sctp_opt2sk(const struct sctp_sock
*sp
)
322 return (struct sock
*)sp
;
325 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
327 struct sctp_sock sctp
;
328 struct ipv6_pinfo inet6
;
330 #endif /* CONFIG_IPV6 */
333 /* This is our APPLICATION-SPECIFIC state cookie.
334 * THIS IS NOT DICTATED BY THE SPECIFICATION.
336 /* These are the parts of an association which we send in the cookie.
337 * Most of these are straight out of:
338 * RFC2960 12.2 Parameters necessary per association (i.e. the TCB)
344 /* My : Tag expected in every inbound packet and sent
345 * Verification: in the INIT or INIT ACK chunk.
350 /* Peer's : Tag expected in every outbound packet except
351 * Verification: in the INIT chunk.
356 /* The rest of these are not from the spec, but really need to
360 /* My Tie Tag : Assist in discovering a restarting association. */
363 /* Peer's Tie Tag: Assist in discovering a restarting association. */
366 /* When does this cookie expire? */
367 struct timeval expiration
;
369 /* Number of inbound/outbound streams which are set
370 * and negotiated during the INIT process.
372 __u16 sinit_num_ostreams
;
373 __u16 sinit_max_instreams
;
375 /* This is the first sequence number I used. */
378 /* This holds the originating address of the INIT packet. */
379 union sctp_addr peer_addr
;
382 * Include the source port of the INIT-ACK
388 /* Padding for future use */
394 /* This is a shim for my peer's INIT packet, followed by
395 * a copy of the raw address list of the association.
396 * The length of the raw address list is saved in the
397 * raw_addr_list_len field, which will be used at the time when
398 * the association TCB is re-constructed from the cookie.
400 __u32 raw_addr_list_len
;
401 struct sctp_init_chunk peer_init
[0];
405 /* The format of our cookie that we send to our peer. */
406 struct sctp_signed_cookie
{
407 __u8 signature
[SCTP_SECRET_SIZE
];
408 __u32 __pad
; /* force sctp_cookie alignment to 64 bits */
409 struct sctp_cookie c
;
410 } __attribute__((packed
));
412 /* This is another convenience type to allocate memory for address
413 * params for the maximum size and pass such structures around
416 union sctp_addr_param
{
417 struct sctp_ipv4addr_param v4
;
418 struct sctp_ipv6addr_param v6
;
421 /* A convenience type to allow walking through the various
422 * parameters and avoid casting all over the place.
426 struct sctp_paramhdr
*p
;
427 struct sctp_cookie_preserve_param
*life
;
428 struct sctp_hostname_param
*dns
;
429 struct sctp_cookie_param
*cookie
;
430 struct sctp_supported_addrs_param
*sat
;
431 struct sctp_ipv4addr_param
*v4
;
432 struct sctp_ipv6addr_param
*v6
;
433 union sctp_addr_param
*addr
;
434 struct sctp_adaption_ind_param
*aind
;
437 /* RFC 2960. Section 3.3.5 Heartbeat.
438 * Heartbeat Information: variable length
439 * The Sender-specific Heartbeat Info field should normally include
440 * information about the sender's current time when this HEARTBEAT
441 * chunk is sent and the destination transport address to which this
442 * HEARTBEAT is sent (see Section 8.3).
444 typedef struct sctp_sender_hb_info
{
445 struct sctp_paramhdr param_hdr
;
446 union sctp_addr daddr
;
447 unsigned long sent_at
;
448 } __attribute__((packed
)) sctp_sender_hb_info_t
;
451 * RFC 2960 1.3.2 Sequenced Delivery within Streams
453 * The term "stream" is used in SCTP to refer to a sequence of user
454 * messages that are to be delivered to the upper-layer protocol in
455 * order with respect to other messages within the same stream. This is
456 * in contrast to its usage in TCP, where it refers to a sequence of
457 * bytes (in this document a byte is assumed to be eight bits).
460 * This is the structure we use to track both our outbound and inbound
461 * SSN, or Stream Sequence Numbers.
470 struct sctp_stream in
;
471 struct sctp_stream out
;
475 struct sctp_ssnmap
*sctp_ssnmap_new(__u16 in
, __u16 out
,
477 void sctp_ssnmap_free(struct sctp_ssnmap
*map
);
478 void sctp_ssnmap_clear(struct sctp_ssnmap
*map
);
480 /* What is the current SSN number for this stream? */
481 static inline __u16
sctp_ssn_peek(struct sctp_stream
*stream
, __u16 id
)
483 return stream
->ssn
[id
];
486 /* Return the next SSN number for this stream. */
487 static inline __u16
sctp_ssn_next(struct sctp_stream
*stream
, __u16 id
)
489 return stream
->ssn
[id
]++;
492 /* Skip over this ssn and all below. */
493 static inline void sctp_ssn_skip(struct sctp_stream
*stream
, __u16 id
,
496 stream
->ssn
[id
] = ssn
+1;
500 * Pointers to address related SCTP functions.
501 * (i.e. things that depend on the address family.)
504 int (*sctp_xmit
) (struct sk_buff
*skb
,
505 struct sctp_transport
*,
507 int (*setsockopt
) (struct sock
*sk
,
512 int (*getsockopt
) (struct sock
*sk
,
517 struct dst_entry
*(*get_dst
) (struct sctp_association
*asoc
,
518 union sctp_addr
*daddr
,
519 union sctp_addr
*saddr
);
520 void (*get_saddr
) (struct sctp_association
*asoc
,
521 struct dst_entry
*dst
,
522 union sctp_addr
*daddr
,
523 union sctp_addr
*saddr
);
524 void (*copy_addrlist
) (struct list_head
*,
525 struct net_device
*);
526 void (*dst_saddr
) (union sctp_addr
*saddr
,
527 struct dst_entry
*dst
,
528 unsigned short port
);
529 int (*cmp_addr
) (const union sctp_addr
*addr1
,
530 const union sctp_addr
*addr2
);
531 void (*addr_copy
) (union sctp_addr
*dst
,
532 union sctp_addr
*src
);
533 void (*from_skb
) (union sctp_addr
*,
536 void (*from_sk
) (union sctp_addr
*,
538 void (*to_sk_saddr
) (union sctp_addr
*,
540 void (*to_sk_daddr
) (union sctp_addr
*,
542 void (*from_addr_param
) (union sctp_addr
*,
543 union sctp_addr_param
*,
544 __u16 port
, int iif
);
545 int (*to_addr_param
) (const union sctp_addr
*,
546 union sctp_addr_param
*);
547 int (*addr_valid
) (union sctp_addr
*,
549 sctp_scope_t (*scope
) (union sctp_addr
*);
550 void (*inaddr_any
) (union sctp_addr
*, unsigned short);
551 int (*is_any
) (const union sctp_addr
*);
552 int (*available
) (union sctp_addr
*,
554 int (*skb_iif
) (const struct sk_buff
*sk
);
555 int (*is_ce
) (const struct sk_buff
*sk
);
556 void (*seq_dump_addr
)(struct seq_file
*seq
,
557 union sctp_addr
*addr
);
558 __u16 net_header_len
;
560 sa_family_t sa_family
;
561 struct list_head list
;
564 struct sctp_af
*sctp_get_af_specific(sa_family_t
);
565 int sctp_register_af(struct sctp_af
*);
567 /* Protocol family functions. */
569 void (*event_msgname
)(struct sctp_ulpevent
*, char *, int *);
570 void (*skb_msgname
) (struct sk_buff
*, char *, int *);
571 int (*af_supported
) (sa_family_t
, struct sctp_sock
*);
572 int (*cmp_addr
) (const union sctp_addr
*,
573 const union sctp_addr
*,
575 int (*bind_verify
) (struct sctp_sock
*, union sctp_addr
*);
576 int (*send_verify
) (struct sctp_sock
*, union sctp_addr
*);
577 int (*supported_addrs
)(const struct sctp_sock
*, __u16
*);
578 struct sock
*(*create_accept_sk
) (struct sock
*sk
,
579 struct sctp_association
*asoc
);
580 void (*addr_v4map
) (struct sctp_sock
*, union sctp_addr
*);
585 /* Structure to track chunk fragments that have been acked, but peer
586 * fragments of the same message have not.
588 struct sctp_datamsg
{
589 /* Chunks waiting to be submitted to lower layer. */
590 struct list_head chunks
;
591 /* Chunks that have been transmitted. */
592 struct list_head track
;
593 /* Reference counting. */
595 /* When is this message no longer interesting to the peer? */
596 unsigned long expires_at
;
597 /* Did the messenge fail to send? */
600 /* Control whether chunks from this message can be abandoned. */
604 struct sctp_datamsg
*sctp_datamsg_from_user(struct sctp_association
*,
605 struct sctp_sndrcvinfo
*,
606 struct msghdr
*, int len
);
607 void sctp_datamsg_put(struct sctp_datamsg
*);
608 void sctp_datamsg_free(struct sctp_datamsg
*);
609 void sctp_datamsg_track(struct sctp_chunk
*);
610 void sctp_chunk_fail(struct sctp_chunk
*, int error
);
611 int sctp_chunk_abandoned(struct sctp_chunk
*);
613 /* RFC2960 1.4 Key Terms
615 * o Chunk: A unit of information within an SCTP packet, consisting of
616 * a chunk header and chunk-specific content.
618 * As a matter of convenience, we remember the SCTP common header for
619 * each chunk as well as a few other header pointers...
622 struct list_head list
;
626 /* This is our link to the per-transport transmitted list. */
627 struct list_head transmitted_list
;
629 /* This field is used by chunks that hold fragmented data.
630 * For the first fragment this is the list that holds the rest of
631 * fragments. For the remaining fragments, this is the link to the
632 * frag_list maintained in the first fragment.
634 struct list_head frag_list
;
636 /* This points to the sk_buff containing the actual data. */
639 /* These are the SCTP headers by reverse order in a packet.
640 * Note that some of these may happen more than once. In that
641 * case, we point at the "current" one, whatever that means
642 * for that level of header.
645 /* We point this at the FIRST TLV parameter to chunk_hdr. */
646 union sctp_params param_hdr
;
649 struct sctp_datahdr
*data_hdr
;
650 struct sctp_inithdr
*init_hdr
;
651 struct sctp_sackhdr
*sack_hdr
;
652 struct sctp_heartbeathdr
*hb_hdr
;
653 struct sctp_sender_hb_info
*hbs_hdr
;
654 struct sctp_shutdownhdr
*shutdown_hdr
;
655 struct sctp_signed_cookie
*cookie_hdr
;
656 struct sctp_ecnehdr
*ecne_hdr
;
657 struct sctp_cwrhdr
*ecn_cwr_hdr
;
658 struct sctp_errhdr
*err_hdr
;
659 struct sctp_addiphdr
*addip_hdr
;
660 struct sctp_fwdtsn_hdr
*fwdtsn_hdr
;
665 struct sctp_chunkhdr
*chunk_hdr
;
666 struct sctphdr
*sctp_hdr
;
668 /* This needs to be recoverable for SCTP_SEND_FAILED events. */
669 struct sctp_sndrcvinfo sinfo
;
671 /* Which association does this belong to? */
672 struct sctp_association
*asoc
;
674 /* What endpoint received this chunk? */
675 struct sctp_ep_common
*rcvr
;
677 /* We fill this in if we are calculating RTT. */
678 unsigned long sent_at
;
680 /* What is the origin IP address for this chunk? */
681 union sctp_addr source
;
682 /* Destination address for this chunk. */
683 union sctp_addr dest
;
685 /* For outbound message, track all fragments for SEND_FAILED. */
686 struct sctp_datamsg
*msg
;
688 /* For an inbound chunk, this tells us where it came from.
689 * For an outbound chunk, it tells us where we'd like it to
690 * go. It is NULL if we have no preference.
692 struct sctp_transport
*transport
;
694 __u8 rtt_in_progress
; /* Is this chunk used for RTT calculation? */
695 __u8 resent
; /* Has this chunk ever been retransmitted. */
696 __u8 has_tsn
; /* Does this chunk have a TSN yet? */
697 __u8 has_ssn
; /* Does this chunk have a SSN yet? */
698 __u8 singleton
; /* Was this the only chunk in the packet? */
699 __u8 end_of_packet
; /* Was this the last chunk in the packet? */
700 __u8 ecn_ce_done
; /* Have we processed the ECN CE bit? */
701 __u8 pdiscard
; /* Discard the whole packet now? */
702 __u8 tsn_gap_acked
; /* Is this chunk acked by a GAP ACK? */
703 __u8 fast_retransmit
; /* Is this chunk fast retransmitted? */
704 __u8 tsn_missing_report
; /* Data chunk missing counter. */
707 void sctp_chunk_hold(struct sctp_chunk
*);
708 void sctp_chunk_put(struct sctp_chunk
*);
709 int sctp_user_addto_chunk(struct sctp_chunk
*chunk
, int off
, int len
,
711 void sctp_chunk_free(struct sctp_chunk
*);
712 void *sctp_addto_chunk(struct sctp_chunk
*, int len
, const void *data
);
713 struct sctp_chunk
*sctp_chunkify(struct sk_buff
*,
714 const struct sctp_association
*,
716 void sctp_init_addrs(struct sctp_chunk
*, union sctp_addr
*,
718 const union sctp_addr
*sctp_source(const struct sctp_chunk
*chunk
);
720 /* This is a structure for holding either an IPv6 or an IPv4 address. */
721 /* sin_family -- AF_INET or AF_INET6
722 * sin_port -- ordinary port number
723 * sin_addr -- cast to either (struct in_addr) or (struct in6_addr)
725 struct sctp_sockaddr_entry
{
726 struct list_head list
;
730 typedef struct sctp_chunk
*(sctp_packet_phandler_t
)(struct sctp_association
*);
732 /* This structure holds lists of chunks as we are assembling for
736 /* These are the SCTP header values (host order) for the packet. */
738 __u16 destination_port
;
741 /* This contains the payload chunks. */
742 struct list_head chunk_list
;
744 /* This is the overhead of the sctp and ip headers. */
746 /* This is the total size of all chunks INCLUDING padding. */
749 /* The packet is destined for this transport address.
750 * The function we finally use to pass down to the next lower
751 * layer lives in the transport structure.
753 struct sctp_transport
*transport
;
755 /* This packet contains a COOKIE-ECHO chunk. */
756 char has_cookie_echo
;
758 /* This packet containsa SACK chunk. */
761 /* SCTP cannot fragment this packet. So let ip fragment it. */
767 struct sctp_packet
*sctp_packet_init(struct sctp_packet
*,
768 struct sctp_transport
*,
769 __u16 sport
, __u16 dport
);
770 struct sctp_packet
*sctp_packet_config(struct sctp_packet
*, __u32 vtag
, int);
771 sctp_xmit_t
sctp_packet_transmit_chunk(struct sctp_packet
*,
772 struct sctp_chunk
*);
773 sctp_xmit_t
sctp_packet_append_chunk(struct sctp_packet
*,
774 struct sctp_chunk
*);
775 int sctp_packet_transmit(struct sctp_packet
*);
776 void sctp_packet_free(struct sctp_packet
*);
778 static inline int sctp_packet_empty(struct sctp_packet
*packet
)
780 return (packet
->size
== packet
->overhead
);
783 /* This represents a remote transport address.
784 * For local transport addresses, we just use union sctp_addr.
786 * RFC2960 Section 1.4 Key Terms
788 * o Transport address: A Transport Address is traditionally defined
789 * by Network Layer address, Transport Layer protocol and Transport
790 * Layer port number. In the case of SCTP running over IP, a
791 * transport address is defined by the combination of an IP address
792 * and an SCTP port number (where SCTP is the Transport protocol).
794 * RFC2960 Section 7.1 SCTP Differences from TCP Congestion control
796 * o The sender keeps a separate congestion control parameter set for
797 * each of the destination addresses it can send to (not each
798 * source-destination pair but for each destination). The parameters
799 * should decay if the address is not used for a long enough time
803 struct sctp_transport
{
804 /* A list of transports. */
805 struct list_head transports
;
807 /* Reference counting. */
811 /* This is the peer's IP address and port. */
812 union sctp_addr ipaddr
;
814 /* These are the functions we call to handle LLP stuff. */
815 struct sctp_af
*af_specific
;
817 /* Which association do we belong to? */
818 struct sctp_association
*asoc
;
822 * 12.3 Per Transport Address Data
824 * For each destination transport address in the peer's
825 * address list derived from the INIT or INIT ACK chunk, a
826 * number of data elements needs to be maintained including:
828 __u32 rtt
; /* This is the most recent RTT. */
830 /* RTO : The current retransmission timeout value. */
833 /* RTTVAR : The current RTT variation. */
836 /* SRTT : The current smoothed round trip time. */
839 /* RTO-Pending : A flag used to track if one of the DATA
840 * chunks sent to this address is currently being
841 * used to compute a RTT. If this flag is 0,
842 * the next DATA chunk sent to this destination
843 * should be used to compute a RTT and this flag
844 * should be set. Every time the RTT
845 * calculation completes (i.e. the DATA chunk
846 * is SACK'd) clear this flag.
851 * These are the congestion stats.
853 /* cwnd : The current congestion window. */
854 __u32 cwnd
; /* This is the actual cwnd. */
856 /* ssthresh : The current slow start threshold value. */
859 /* partial : The tracking method for increase of cwnd when in
860 * bytes acked : congestion avoidance mode (see Section 6.2.2)
862 __u32 partial_bytes_acked
;
864 /* Data that has been sent, but not acknowledged. */
868 struct dst_entry
*dst
;
869 /* Source address. */
870 union sctp_addr saddr
;
872 /* When was the last time(in jiffies) that a data packet was sent on
873 * this transport? This is used to adjust the cwnd when the transport
876 unsigned long last_time_used
;
878 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
879 * the destination address every heartbeat interval.
881 unsigned long hbinterval
;
883 /* SACK delay timeout */
884 unsigned long sackdelay
;
886 /* When was the last time (in jiffies) that we heard from this
887 * transport? We use this to pick new active and retran paths.
889 unsigned long last_time_heard
;
891 /* Last time(in jiffies) when cwnd is reduced due to the congestion
892 * indication based on ECNE chunk.
894 unsigned long last_time_ecne_reduced
;
896 /* This is the max_retrans value for the transport and will
897 * be initialized from the assocs value. This can be changed
898 * using SCTP_SET_PEER_ADDR_PARAMS socket option.
902 /* PMTU : The current known path MTU. */
905 /* Flags controling Heartbeat, SACK delay, and Path MTU Discovery. */
908 /* The number of times INIT has been sent on this transport. */
911 /* state : The current state of this destination,
912 * : i.e. SCTP_ACTIVE, SCTP_INACTIVE, SCTP_UNKOWN.
916 /* These are the error stats for this destination. */
918 /* Error count : The current error count for this destination. */
919 unsigned short error_count
;
921 /* Per : A timer used by each destination.
925 * [Everywhere else in the text this is called T3-rtx. -ed]
927 struct timer_list T3_rtx_timer
;
929 /* Heartbeat timer is per destination. */
930 struct timer_list hb_timer
;
932 /* Since we're using per-destination retransmission timers
933 * (see above), we're also using per-destination "transmitted"
934 * queues. This probably ought to be a private struct
935 * accessible only within the outqueue, but it's not, yet.
937 struct list_head transmitted
;
939 /* We build bundle-able packets for this transport here. */
940 struct sctp_packet packet
;
942 /* This is the list of transports that have chunks to send. */
943 struct list_head send_ready
;
945 int malloced
; /* Is this structure kfree()able? */
947 /* State information saved for SFR_CACC algorithm. The key
948 * idea in SFR_CACC is to maintain state at the sender on a
949 * per-destination basis when a changeover happens.
950 * char changeover_active;
951 * char cycling_changeover;
952 * __u32 next_tsn_at_change;
953 * char cacc_saw_newack;
956 /* An unsigned integer, which stores the next TSN to be
957 * used by the sender, at the moment of changeover.
959 __u32 next_tsn_at_change
;
961 /* A flag which indicates the occurrence of a changeover */
962 char changeover_active
;
964 /* A flag which indicates whether the change of primary is
965 * the first switch to this destination address during an
968 char cycling_changeover
;
970 /* A temporary flag, which is used during the processing of
971 * a SACK to estimate the causative TSN(s)'s group.
973 char cacc_saw_newack
;
977 struct sctp_transport
*sctp_transport_new(const union sctp_addr
*,
979 void sctp_transport_set_owner(struct sctp_transport
*,
980 struct sctp_association
*);
981 void sctp_transport_route(struct sctp_transport
*, union sctp_addr
*,
983 void sctp_transport_pmtu(struct sctp_transport
*);
984 void sctp_transport_free(struct sctp_transport
*);
985 void sctp_transport_reset_timers(struct sctp_transport
*);
986 void sctp_transport_hold(struct sctp_transport
*);
987 void sctp_transport_put(struct sctp_transport
*);
988 void sctp_transport_update_rto(struct sctp_transport
*, __u32
);
989 void sctp_transport_raise_cwnd(struct sctp_transport
*, __u32
, __u32
);
990 void sctp_transport_lower_cwnd(struct sctp_transport
*, sctp_lower_cwnd_t
);
991 unsigned long sctp_transport_timeout(struct sctp_transport
*);
994 /* This is the structure we use to queue packets as they come into
995 * SCTP. We write packets to it and read chunks from it.
998 /* This is actually a queue of sctp_chunk each
999 * containing a partially decoded packet.
1001 struct list_head in_chunk_list
;
1002 /* This is the packet which is currently off the in queue and is
1003 * being worked on through the inbound chunk processing.
1005 struct sctp_chunk
*in_progress
;
1007 /* This is the delayed task to finish delivering inbound
1010 struct work_struct immediate
;
1012 int malloced
; /* Is this structure kfree()able? */
1015 void sctp_inq_init(struct sctp_inq
*);
1016 void sctp_inq_free(struct sctp_inq
*);
1017 void sctp_inq_push(struct sctp_inq
*, struct sctp_chunk
*packet
);
1018 struct sctp_chunk
*sctp_inq_pop(struct sctp_inq
*);
1019 void sctp_inq_set_th_handler(struct sctp_inq
*, void (*)(void *), void *);
1021 /* This is the structure we use to hold outbound chunks. You push
1022 * chunks in and they automatically pop out the other end as bundled
1023 * packets (it calls (*output_handler)()).
1025 * This structure covers sections 6.3, 6.4, 6.7, 6.8, 6.10, 7., 8.1,
1026 * and 8.2 of the v13 draft.
1028 * It handles retransmissions. The connection to the timeout portion
1029 * of the state machine is through sctp_..._timeout() and timeout_handler.
1031 * If you feed it SACKs, it will eat them.
1033 * If you give it big chunks, it will fragment them.
1035 * It assigns TSN's to data chunks. This happens at the last possible
1036 * instant before transmission.
1038 * When free()'d, it empties itself out via output_handler().
1041 struct sctp_association
*asoc
;
1043 /* Data pending that has never been transmitted. */
1044 struct list_head out_chunk_list
;
1046 unsigned out_qlen
; /* Total length of queued data chunks. */
1048 /* Error of send failed, may used in SCTP_SEND_FAILED event. */
1051 /* These are control chunks we want to send. */
1052 struct list_head control_chunk_list
;
1054 /* These are chunks that have been sacked but are above the
1055 * CTSN, or cumulative tsn ack point.
1057 struct list_head sacked
;
1059 /* Put chunks on this list to schedule them for
1062 struct list_head retransmit
;
1064 /* Put chunks on this list to save them for FWD TSN processing as
1065 * they were abandoned.
1067 struct list_head abandoned
;
1069 /* How many unackd bytes do we have in-flight? */
1070 __u32 outstanding_bytes
;
1075 /* Is this structure empty? */
1078 /* Are we kfree()able? */
1082 void sctp_outq_init(struct sctp_association
*, struct sctp_outq
*);
1083 void sctp_outq_teardown(struct sctp_outq
*);
1084 void sctp_outq_free(struct sctp_outq
*);
1085 int sctp_outq_tail(struct sctp_outq
*, struct sctp_chunk
*chunk
);
1086 int sctp_outq_flush(struct sctp_outq
*, int);
1087 int sctp_outq_sack(struct sctp_outq
*, struct sctp_sackhdr
*);
1088 int sctp_outq_is_empty(const struct sctp_outq
*);
1089 void sctp_outq_restart(struct sctp_outq
*);
1091 void sctp_retransmit(struct sctp_outq
*, struct sctp_transport
*,
1092 sctp_retransmit_reason_t
);
1093 void sctp_retransmit_mark(struct sctp_outq
*, struct sctp_transport
*, __u8
);
1094 int sctp_outq_uncork(struct sctp_outq
*);
1095 /* Uncork and flush an outqueue. */
1096 static inline void sctp_outq_cork(struct sctp_outq
*q
)
1101 /* These bind address data fields common between endpoints and associations */
1102 struct sctp_bind_addr
{
1104 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1106 * SCTP Port: The local SCTP port number the endpoint is
1111 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1113 * Address List: The list of IP addresses that this instance
1114 * has bound. This information is passed to one's
1115 * peer(s) in INIT and INIT ACK chunks.
1117 struct list_head address_list
;
1119 int malloced
; /* Are we kfree()able? */
1122 void sctp_bind_addr_init(struct sctp_bind_addr
*, __u16 port
);
1123 void sctp_bind_addr_free(struct sctp_bind_addr
*);
1124 int sctp_bind_addr_copy(struct sctp_bind_addr
*dest
,
1125 const struct sctp_bind_addr
*src
,
1126 sctp_scope_t scope
, gfp_t gfp
,
1128 int sctp_add_bind_addr(struct sctp_bind_addr
*, union sctp_addr
*,
1130 int sctp_del_bind_addr(struct sctp_bind_addr
*, union sctp_addr
*);
1131 int sctp_bind_addr_match(struct sctp_bind_addr
*, const union sctp_addr
*,
1132 struct sctp_sock
*);
1133 union sctp_addr
*sctp_find_unmatch_addr(struct sctp_bind_addr
*bp
,
1134 const union sctp_addr
*addrs
,
1136 struct sctp_sock
*opt
);
1137 union sctp_params
sctp_bind_addrs_to_raw(const struct sctp_bind_addr
*bp
,
1140 int sctp_raw_to_bind_addrs(struct sctp_bind_addr
*bp
, __u8
*raw
, int len
,
1141 __u16 port
, gfp_t gfp
);
1143 sctp_scope_t
sctp_scope(const union sctp_addr
*);
1144 int sctp_in_scope(const union sctp_addr
*addr
, const sctp_scope_t scope
);
1145 int sctp_is_any(const union sctp_addr
*addr
);
1146 int sctp_addr_is_valid(const union sctp_addr
*addr
);
1149 /* What type of endpoint? */
1151 SCTP_EP_TYPE_SOCKET
,
1152 SCTP_EP_TYPE_ASSOCIATION
,
1153 } sctp_endpoint_type_t
;
1156 * A common base class to bridge the implmentation view of a
1157 * socket (usually listening) endpoint versus an association's
1159 * This common structure is useful for several purposes:
1160 * 1) Common interface for lookup routines.
1161 * a) Subfunctions work for either endpoint or association
1162 * b) Single interface to lookup allows hiding the lookup lock rather
1163 * than acquiring it externally.
1164 * 2) Common interface for the inbound chunk handling/state machine.
1165 * 3) Common object handling routines for reference counting, etc.
1166 * 4) Disentangle association lookup from endpoint lookup, where we
1167 * do not have to find our endpoint to find our association.
1171 struct sctp_ep_common
{
1172 /* Fields to help us manage our entries in the hash tables. */
1173 struct sctp_ep_common
*next
;
1174 struct sctp_ep_common
**pprev
;
1177 /* Runtime type information. What kind of endpoint is this? */
1178 sctp_endpoint_type_t type
;
1180 /* Some fields to help us manage this object.
1181 * refcnt - Reference count access to this object.
1182 * dead - Do not attempt to use this object.
1183 * malloced - Do we need to kfree this object?
1189 /* What socket does this endpoint belong to? */
1192 /* This is where we receive inbound chunks. */
1193 struct sctp_inq inqueue
;
1195 /* This substructure includes the defining parameters of the
1197 * bind_addr.port is our shared port number.
1198 * bind_addr.address_list is our set of local IP addresses.
1200 struct sctp_bind_addr bind_addr
;
1202 /* Protection during address list comparisons. */
1207 /* RFC Section 1.4 Key Terms
1209 * o SCTP endpoint: The logical sender/receiver of SCTP packets. On a
1210 * multi-homed host, an SCTP endpoint is represented to its peers as a
1211 * combination of a set of eligible destination transport addresses to
1212 * which SCTP packets can be sent and a set of eligible source
1213 * transport addresses from which SCTP packets can be received.
1214 * All transport addresses used by an SCTP endpoint must use the
1215 * same port number, but can use multiple IP addresses. A transport
1216 * address used by an SCTP endpoint must not be used by another
1217 * SCTP endpoint. In other words, a transport address is unique
1218 * to an SCTP endpoint.
1220 * From an implementation perspective, each socket has one of these.
1221 * A TCP-style socket will have exactly one association on one of
1222 * these. An UDP-style socket will have multiple associations hanging
1226 struct sctp_endpoint
{
1227 /* Common substructure for endpoint and association. */
1228 struct sctp_ep_common base
;
1230 /* Associations: A list of current associations and mappings
1231 * to the data consumers for each association. This
1232 * may be in the form of a hash table or other
1233 * implementation dependent structure. The data
1234 * consumers may be process identification
1235 * information such as file descriptors, named pipe
1236 * pointer, or table pointers dependent on how SCTP
1239 /* This is really a list of struct sctp_association entries. */
1240 struct list_head asocs
;
1242 /* Secret Key: A secret key used by this endpoint to compute
1243 * the MAC. This SHOULD be a cryptographic quality
1244 * random number with a sufficient length.
1245 * Discussion in [RFC1750] can be helpful in
1246 * selection of the key.
1248 __u8 secret_key
[SCTP_HOW_MANY_SECRETS
][SCTP_SECRET_SIZE
];
1253 /* sendbuf acct. policy. */
1254 __u32 sndbuf_policy
;
1256 /* rcvbuf acct. policy. */
1257 __u32 rcvbuf_policy
;
1260 /* Recover the outter endpoint structure. */
1261 static inline struct sctp_endpoint
*sctp_ep(struct sctp_ep_common
*base
)
1263 struct sctp_endpoint
*ep
;
1265 ep
= container_of(base
, struct sctp_endpoint
, base
);
1269 /* These are function signatures for manipulating endpoints. */
1270 struct sctp_endpoint
*sctp_endpoint_new(struct sock
*, gfp_t
);
1271 void sctp_endpoint_free(struct sctp_endpoint
*);
1272 void sctp_endpoint_put(struct sctp_endpoint
*);
1273 void sctp_endpoint_hold(struct sctp_endpoint
*);
1274 void sctp_endpoint_add_asoc(struct sctp_endpoint
*, struct sctp_association
*);
1275 struct sctp_association
*sctp_endpoint_lookup_assoc(
1276 const struct sctp_endpoint
*ep
,
1277 const union sctp_addr
*paddr
,
1278 struct sctp_transport
**);
1279 int sctp_endpoint_is_peeled_off(struct sctp_endpoint
*,
1280 const union sctp_addr
*);
1281 struct sctp_endpoint
*sctp_endpoint_is_match(struct sctp_endpoint
*,
1282 const union sctp_addr
*);
1283 int sctp_has_association(const union sctp_addr
*laddr
,
1284 const union sctp_addr
*paddr
);
1286 int sctp_verify_init(const struct sctp_association
*asoc
, sctp_cid_t
,
1287 sctp_init_chunk_t
*peer_init
, struct sctp_chunk
*chunk
,
1288 struct sctp_chunk
**err_chunk
);
1289 int sctp_process_init(struct sctp_association
*, sctp_cid_t cid
,
1290 const union sctp_addr
*peer
,
1291 sctp_init_chunk_t
*init
, gfp_t gfp
);
1292 __u32
sctp_generate_tag(const struct sctp_endpoint
*);
1293 __u32
sctp_generate_tsn(const struct sctp_endpoint
*);
1298 * 12. Recommended Transmission Control Block (TCB) Parameters
1300 * This section details a recommended set of parameters that should
1301 * be contained within the TCB for an implementation. This section is
1302 * for illustrative purposes and should not be deemed as requirements
1303 * on an implementation or as an exhaustive list of all parameters
1304 * inside an SCTP TCB. Each implementation may need its own additional
1305 * parameters for optimization.
1309 /* Here we have information about each individual association. */
1310 struct sctp_association
{
1312 /* A base structure common to endpoint and association.
1313 * In this context, it represents the associations's view
1314 * of the local endpoint of the association.
1316 struct sctp_ep_common base
;
1318 /* Associations on the same socket. */
1319 struct list_head asocs
;
1321 /* association id. */
1322 sctp_assoc_t assoc_id
;
1324 /* This is our parent endpoint. */
1325 struct sctp_endpoint
*ep
;
1327 /* These are those association elements needed in the cookie. */
1328 struct sctp_cookie c
;
1330 /* This is all information about our peer. */
1334 * Peer Rwnd : Current calculated value of the peer's rwnd.
1338 /* transport_addr_list
1340 * Peer : A list of SCTP transport addresses that the
1341 * Transport : peer is bound to. This information is derived
1342 * Address : from the INIT or INIT ACK and is used to
1343 * List : associate an inbound packet with a given
1344 * : association. Normally this information is
1345 * : hashed or keyed for quick lookup and access
1347 * : The list is also initialized with the list
1348 * : of addresses passed with the sctp_connectx()
1351 * It is a list of SCTP_transport's.
1353 struct list_head transport_addr_list
;
1357 * Peer : A count of the number of peer addresses
1358 * Transport : in the Peer Transport Address List.
1362 __u16 transport_count
;
1365 * The transport layer port number.
1371 * Primary : This is the current primary destination
1372 * Path : transport address of the peer endpoint. It
1373 * : may also specify a source transport address
1374 * : on this endpoint.
1376 * All of these paths live on transport_addr_list.
1378 * At the bakeoffs, we discovered that the intent of
1379 * primaryPath is that it only changes when the ULP
1380 * asks to have it changed. We add the activePath to
1381 * designate the connection we are currently using to
1382 * transmit new data and most control chunks.
1384 struct sctp_transport
*primary_path
;
1386 /* Cache the primary path address here, when we
1387 * need a an address for msg_name.
1389 union sctp_addr primary_addr
;
1392 * The path that we are currently using to
1393 * transmit new data and most control chunks.
1395 struct sctp_transport
*active_path
;
1399 * RFC2960 6.4 Multi-homed SCTP Endpoints
1401 * Furthermore, when its peer is multi-homed, an
1402 * endpoint SHOULD try to retransmit a chunk to an
1403 * active destination transport address that is
1404 * different from the last destination address to
1405 * which the DATA chunk was sent.
1407 struct sctp_transport
*retran_path
;
1409 /* Pointer to last transport I have sent on. */
1410 struct sctp_transport
*last_sent_to
;
1412 /* This is the last transport I have received DATA on. */
1413 struct sctp_transport
*last_data_from
;
1416 * Mapping An array of bits or bytes indicating which out of
1417 * Array order TSN's have been received (relative to the
1418 * Last Rcvd TSN). If no gaps exist, i.e. no out of
1419 * order packets have been received, this array
1420 * will be set to all zero. This structure may be
1421 * in the form of a circular buffer or bit array.
1423 * Last Rcvd : This is the last TSN received in
1424 * TSN : sequence. This value is set initially by
1425 * : taking the peer's Initial TSN, received in
1426 * : the INIT or INIT ACK chunk, and subtracting
1429 * Throughout most of the specification this is called the
1430 * "Cumulative TSN ACK Point". In this case, we
1431 * ignore the advice in 12.2 in favour of the term
1432 * used in the bulk of the text. This value is hidden
1433 * in tsn_map--we get it by calling sctp_tsnmap_get_ctsn().
1435 struct sctp_tsnmap tsn_map
;
1436 __u8 _map
[sctp_tsnmap_storage_size(SCTP_TSN_MAP_SIZE
)];
1438 /* Ack State : This flag indicates if the next received
1439 * : packet is to be responded to with a
1440 * : SACK. This is initializedto 0. When a packet
1441 * : is received it is incremented. If this value
1442 * : reaches 2 or more, a SACK is sent and the
1443 * : value is reset to 0. Note: This is used only
1444 * : when no DATA chunks are received out of
1445 * : order. When DATA chunks are out of order,
1446 * : SACK's are not delayed (see Section 6).
1448 __u8 sack_needed
; /* Do we need to sack the peer? */
1450 /* These are capabilities which our peer advertised. */
1451 __u8 ecn_capable
; /* Can peer do ECN? */
1452 __u8 ipv4_address
; /* Peer understands IPv4 addresses? */
1453 __u8 ipv6_address
; /* Peer understands IPv6 addresses? */
1454 __u8 hostname_address
;/* Peer understands DNS addresses? */
1455 __u8 asconf_capable
; /* Does peer support ADDIP? */
1456 __u8 prsctp_capable
; /* Can peer do PR-SCTP? */
1458 __u32 adaption_ind
; /* Adaption Code point. */
1460 /* This mask is used to disable sending the ASCONF chunk
1461 * with specified parameter to peer.
1463 __u16 addip_disabled_mask
;
1465 struct sctp_inithdr i
;
1469 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
1470 * C1) ... "Peer-Serial-Number'. This value MUST be initialized to the
1471 * Initial TSN Value minus 1
1476 /* State : A state variable indicating what state the
1477 * : association is in, i.e. COOKIE-WAIT,
1478 * : COOKIE-ECHOED, ESTABLISHED, SHUTDOWN-PENDING,
1479 * : SHUTDOWN-SENT, SHUTDOWN-RECEIVED, SHUTDOWN-ACK-SENT.
1481 * Note: No "CLOSED" state is illustrated since if a
1482 * association is "CLOSED" its TCB SHOULD be removed.
1484 * In this implementation we DO have a CLOSED
1485 * state which is used during initiation and shutdown.
1487 * State takes values from SCTP_STATE_*.
1491 /* The cookie life I award for any cookie. */
1492 struct timeval cookie_life
;
1494 /* Overall : The overall association error count.
1495 * Error Count : [Clear this any time I get something.]
1497 int overall_error_count
;
1499 /* These are the association's initial, max, and min RTO values.
1500 * These values will be initialized by system defaults, but can
1501 * be modified via the SCTP_RTOINFO socket option.
1503 unsigned long rto_initial
;
1504 unsigned long rto_max
;
1505 unsigned long rto_min
;
1507 /* Maximum number of new data packets that can be sent in a burst. */
1510 /* This is the max_retrans value for the association. This value will
1511 * be initialized initialized from system defaults, but can be
1512 * modified by the SCTP_ASSOCINFO socket option.
1516 /* Maximum number of times the endpoint will retransmit INIT */
1517 __u16 max_init_attempts
;
1519 /* How many times have we resent an INIT? */
1522 /* The largest timeout or RTO value to use in attempting an INIT */
1523 unsigned long max_init_timeo
;
1525 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
1526 * the destination address every heartbeat interval. This value
1527 * will be inherited by all new transports.
1529 unsigned long hbinterval
;
1531 /* This is the max_retrans value for new transports in the
1536 /* Association : The smallest PMTU discovered for all of the
1537 * PMTU : peer's transport addresses.
1541 /* Flags controling Heartbeat, SACK delay, and Path MTU Discovery. */
1544 /* SACK delay timeout */
1545 unsigned long sackdelay
;
1548 unsigned long timeouts
[SCTP_NUM_TIMEOUT_TYPES
];
1549 struct timer_list timers
[SCTP_NUM_TIMEOUT_TYPES
];
1551 /* Transport to which SHUTDOWN chunk was last sent. */
1552 struct sctp_transport
*shutdown_last_sent_to
;
1554 /* Transport to which INIT chunk was last sent. */
1555 struct sctp_transport
*init_last_sent_to
;
1557 /* Next TSN : The next TSN number to be assigned to a new
1558 * : DATA chunk. This is sent in the INIT or INIT
1559 * : ACK chunk to the peer and incremented each
1560 * : time a DATA chunk is assigned a TSN
1561 * : (normally just prior to transmit or during
1567 * Last Rcvd : This is the last TSN received in sequence. This value
1568 * TSN : is set initially by taking the peer's Initial TSN,
1569 * : received in the INIT or INIT ACK chunk, and
1570 * : subtracting one from it.
1572 * Most of RFC 2960 refers to this as the Cumulative TSN Ack Point.
1575 __u32 ctsn_ack_point
;
1577 /* PR-SCTP Advanced.Peer.Ack.Point */
1578 __u32 adv_peer_ack_point
;
1580 /* Highest TSN that is acknowledged by incoming SACKs. */
1581 __u32 highest_sacked
;
1583 /* The number of unacknowledged data chunks. Reported through
1584 * the SCTP_STATUS sockopt.
1588 /* This is the association's receive buffer space. This value is used
1589 * to set a_rwnd field in an INIT or a SACK chunk.
1593 /* This is the last advertised value of rwnd over a SACK chunk. */
1596 /* Number of bytes by which the rwnd has slopped. The rwnd is allowed
1597 * to slop over a maximum of the association's frag_point.
1601 /* This is the sndbuf size in use for the association.
1602 * This corresponds to the sndbuf size for the association,
1603 * as specified in the sk->sndbuf.
1607 /* This is the amount of memory that this association has allocated
1608 * in the receive path at any given time.
1610 atomic_t rmem_alloc
;
1612 /* This is the wait queue head for send requests waiting on
1613 * the association sndbuf space.
1615 wait_queue_head_t wait
;
1617 /* The message size at which SCTP fragmentation will occur. */
1620 /* Counter used to count INIT errors. */
1621 int init_err_counter
;
1623 /* Count the number of INIT cycles (for doubling timeout). */
1626 /* Default send parameters. */
1627 __u16 default_stream
;
1628 __u16 default_flags
;
1630 __u32 default_context
;
1631 __u32 default_timetolive
;
1633 /* This tracks outbound ssn for a given stream. */
1634 struct sctp_ssnmap
*ssnmap
;
1636 /* All outbound chunks go through this structure. */
1637 struct sctp_outq outqueue
;
1639 /* A smart pipe that will handle reordering and fragmentation,
1640 * as well as handle passing events up to the ULP.
1642 struct sctp_ulpq ulpq
;
1644 /* Last TSN that caused an ECNE Chunk to be sent. */
1645 __u32 last_ecne_tsn
;
1647 /* Last TSN that caused a CWR Chunk to be sent. */
1650 /* How many duplicated TSNs have we seen? */
1653 /* Number of seconds of idle time before an association is closed.
1654 * In the association context, this is really used as a boolean
1655 * since the real timeout is stored in the timeouts array
1659 /* These are to support
1660 * "SCTP Extensions for Dynamic Reconfiguration of IP Addresses
1661 * and Enforcement of Flow and Message Limits"
1662 * <draft-ietf-tsvwg-addip-sctp-02.txt>
1663 * or "ADDIP" for short.
1668 /* ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1670 * R1) One and only one ASCONF Chunk MAY be in transit and
1671 * unacknowledged at any one time. If a sender, after sending
1672 * an ASCONF chunk, decides it needs to transfer another
1673 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1674 * returns from the previous ASCONF Chunk before sending a
1675 * subsequent ASCONF. Note this restriction binds each side,
1676 * so at any time two ASCONF may be in-transit on any given
1677 * association (one sent from each endpoint).
1679 * [This is our one-and-only-one ASCONF in flight. If we do
1680 * not have an ASCONF in flight, this is NULL.]
1682 struct sctp_chunk
*addip_last_asconf
;
1684 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
1686 * IMPLEMENTATION NOTE: As an optimization a receiver may wish
1687 * to save the last ASCONF-ACK for some predetermined period
1688 * of time and instead of re-processing the ASCONF (with the
1689 * same serial number) it may just re-transmit the
1690 * ASCONF-ACK. It may wish to use the arrival of a new serial
1691 * number to discard the previously saved ASCONF-ACK or any
1692 * other means it may choose to expire the saved ASCONF-ACK.
1694 * [This is our saved ASCONF-ACK. We invalidate it when a new
1695 * ASCONF serial number arrives.]
1697 struct sctp_chunk
*addip_last_asconf_ack
;
1699 /* These ASCONF chunks are waiting to be sent.
1701 * These chunaks can't be pushed to outqueue until receiving
1702 * ASCONF_ACK for the previous ASCONF indicated by
1703 * addip_last_asconf, so as to guarantee that only one ASCONF
1704 * is in flight at any time.
1706 * ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1708 * In defining the ASCONF Chunk transfer procedures, it is
1709 * essential that these transfers MUST NOT cause congestion
1710 * within the network. To achieve this, we place these
1711 * restrictions on the transfer of ASCONF Chunks:
1713 * R1) One and only one ASCONF Chunk MAY be in transit and
1714 * unacknowledged at any one time. If a sender, after sending
1715 * an ASCONF chunk, decides it needs to transfer another
1716 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1717 * returns from the previous ASCONF Chunk before sending a
1718 * subsequent ASCONF. Note this restriction binds each side,
1719 * so at any time two ASCONF may be in-transit on any given
1720 * association (one sent from each endpoint).
1723 * [I really think this is EXACTLY the sort of intelligence
1724 * which already resides in sctp_outq. Please move this
1725 * queue and its supporting logic down there. --piggy]
1727 struct list_head addip_chunk_list
;
1729 /* ADDIP Section 4.1 ASCONF Chunk Procedures
1731 * A2) A serial number should be assigned to the Chunk. The
1732 * serial number SHOULD be a monotonically increasing
1733 * number. The serial number SHOULD be initialized at
1734 * the start of the association to the same value as the
1735 * Initial TSN and every time a new ASCONF chunk is created
1736 * it is incremented by one after assigning the serial number
1737 * to the newly created chunk.
1740 * 3.1.1 Address/Stream Configuration Change Chunk (ASCONF)
1742 * Serial Number : 32 bits (unsigned integer)
1744 * This value represents a Serial Number for the ASCONF
1745 * Chunk. The valid range of Serial Number is from 0 to
1746 * 4294967295 (2^32 - 1). Serial Numbers wrap back to 0
1747 * after reaching 4294967295.
1751 /* Need to send an ECNE Chunk? */
1754 /* Is it a temporary association? */
1759 /* An eyecatcher for determining if we are really looking at an
1760 * association data structure.
1763 SCTP_ASSOC_EYECATCHER
= 0xa550c123,
1766 /* Recover the outter association structure. */
1767 static inline struct sctp_association
*sctp_assoc(struct sctp_ep_common
*base
)
1769 struct sctp_association
*asoc
;
1771 asoc
= container_of(base
, struct sctp_association
, base
);
1775 /* These are function signatures for manipulating associations. */
1778 struct sctp_association
*
1779 sctp_association_new(const struct sctp_endpoint
*, const struct sock
*,
1780 sctp_scope_t scope
, gfp_t gfp
);
1781 void sctp_association_free(struct sctp_association
*);
1782 void sctp_association_put(struct sctp_association
*);
1783 void sctp_association_hold(struct sctp_association
*);
1785 struct sctp_transport
*sctp_assoc_choose_init_transport(
1786 struct sctp_association
*);
1787 struct sctp_transport
*sctp_assoc_choose_shutdown_transport(
1788 struct sctp_association
*);
1789 void sctp_assoc_update_retran_path(struct sctp_association
*);
1790 struct sctp_transport
*sctp_assoc_lookup_paddr(const struct sctp_association
*,
1791 const union sctp_addr
*);
1792 int sctp_assoc_lookup_laddr(struct sctp_association
*asoc
,
1793 const union sctp_addr
*laddr
);
1794 struct sctp_transport
*sctp_assoc_add_peer(struct sctp_association
*,
1795 const union sctp_addr
*address
,
1797 const int peer_state
);
1798 void sctp_assoc_del_peer(struct sctp_association
*asoc
,
1799 const union sctp_addr
*addr
);
1800 void sctp_assoc_rm_peer(struct sctp_association
*asoc
,
1801 struct sctp_transport
*peer
);
1802 void sctp_assoc_control_transport(struct sctp_association
*,
1803 struct sctp_transport
*,
1804 sctp_transport_cmd_t
, sctp_sn_error_t
);
1805 struct sctp_transport
*sctp_assoc_lookup_tsn(struct sctp_association
*, __u32
);
1806 struct sctp_transport
*sctp_assoc_is_match(struct sctp_association
*,
1807 const union sctp_addr
*,
1808 const union sctp_addr
*);
1809 void sctp_assoc_migrate(struct sctp_association
*, struct sock
*);
1810 void sctp_assoc_update(struct sctp_association
*old
,
1811 struct sctp_association
*new);
1813 __u32
sctp_association_get_next_tsn(struct sctp_association
*);
1815 void sctp_assoc_sync_pmtu(struct sctp_association
*);
1816 void sctp_assoc_rwnd_increase(struct sctp_association
*, unsigned);
1817 void sctp_assoc_rwnd_decrease(struct sctp_association
*, unsigned);
1818 void sctp_assoc_set_primary(struct sctp_association
*,
1819 struct sctp_transport
*);
1820 int sctp_assoc_set_bind_addr_from_ep(struct sctp_association
*,
1822 int sctp_assoc_set_bind_addr_from_cookie(struct sctp_association
*,
1823 struct sctp_cookie
*,
1826 int sctp_cmp_addr_exact(const union sctp_addr
*ss1
,
1827 const union sctp_addr
*ss2
);
1828 struct sctp_chunk
*sctp_get_ecne_prepend(struct sctp_association
*asoc
);
1830 /* A convenience structure to parse out SCTP specific CMSGs. */
1831 typedef struct sctp_cmsgs
{
1832 struct sctp_initmsg
*init
;
1833 struct sctp_sndrcvinfo
*info
;
1836 /* Structure for tracking memory objects */
1840 } sctp_dbg_objcnt_entry_t
;
1842 #endif /* __sctp_structs_h__ */