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.)
134 /* Note: rto_alpha and rto_beta are really defined as inverse
135 * powers of two to facilitate integer operations.
143 /* Valid.Cookie.Life - 60 seconds */
144 int valid_cookie_life
;
146 /* Whether Cookie Preservative is enabled(1) or not(0) */
147 int cookie_preserve_enable
;
149 /* Association.Max.Retrans - 10 attempts
150 * Path.Max.Retrans - 5 attempts (per destination address)
151 * Max.Init.Retransmits - 8 attempts
153 int max_retrans_association
;
154 int max_retrans_path
;
155 int max_retrans_init
;
158 * Policy for preforming sctp/socket accounting
159 * 0 - do socket level accounting, all assocs share sk_sndbuf
160 * 1 - do sctp accounting, each asoc may use sk_sndbuf bytes
165 * Policy for preforming sctp/socket accounting
166 * 0 - do socket level accounting, all assocs share sk_rcvbuf
167 * 1 - do sctp accounting, each asoc may use sk_rcvbuf bytes
171 /* Delayed SACK timeout 200ms default*/
174 /* HB.interval - 30 seconds */
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 struct sctp_initmsg initmsg
;
281 struct sctp_rtoinfo rtoinfo
;
282 struct sctp_paddrparams paddrparam
;
283 struct sctp_event_subscribe subscribe
;
284 struct sctp_assocparams assocparams
;
288 __u8 disable_fragments
;
293 /* Receive to here while partial delivery is in effect. */
294 struct sk_buff_head pd_lobby
;
297 static inline struct sctp_sock
*sctp_sk(const struct sock
*sk
)
299 return (struct sctp_sock
*)sk
;
302 static inline struct sock
*sctp_opt2sk(const struct sctp_sock
*sp
)
304 return (struct sock
*)sp
;
307 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
309 struct sctp_sock sctp
;
310 struct ipv6_pinfo inet6
;
312 #endif /* CONFIG_IPV6 */
315 /* This is our APPLICATION-SPECIFIC state cookie.
316 * THIS IS NOT DICTATED BY THE SPECIFICATION.
318 /* These are the parts of an association which we send in the cookie.
319 * Most of these are straight out of:
320 * RFC2960 12.2 Parameters necessary per association (i.e. the TCB)
326 /* My : Tag expected in every inbound packet and sent
327 * Verification: in the INIT or INIT ACK chunk.
332 /* Peer's : Tag expected in every outbound packet except
333 * Verification: in the INIT chunk.
338 /* The rest of these are not from the spec, but really need to
342 /* My Tie Tag : Assist in discovering a restarting association. */
345 /* Peer's Tie Tag: Assist in discovering a restarting association. */
348 /* When does this cookie expire? */
349 struct timeval expiration
;
351 /* Number of inbound/outbound streams which are set
352 * and negotiated during the INIT process.
354 __u16 sinit_num_ostreams
;
355 __u16 sinit_max_instreams
;
357 /* This is the first sequence number I used. */
360 /* This holds the originating address of the INIT packet. */
361 union sctp_addr peer_addr
;
364 * Include the source port of the INIT-ACK
370 /* Padding for future use */
376 /* This is a shim for my peer's INIT packet, followed by
377 * a copy of the raw address list of the association.
378 * The length of the raw address list is saved in the
379 * raw_addr_list_len field, which will be used at the time when
380 * the association TCB is re-constructed from the cookie.
382 __u32 raw_addr_list_len
;
383 struct sctp_init_chunk peer_init
[0];
387 /* The format of our cookie that we send to our peer. */
388 struct sctp_signed_cookie
{
389 __u8 signature
[SCTP_SECRET_SIZE
];
390 struct sctp_cookie c
;
393 /* This is another convenience type to allocate memory for address
394 * params for the maximum size and pass such structures around
397 union sctp_addr_param
{
398 struct sctp_ipv4addr_param v4
;
399 struct sctp_ipv6addr_param v6
;
402 /* A convenience type to allow walking through the various
403 * parameters and avoid casting all over the place.
407 struct sctp_paramhdr
*p
;
408 struct sctp_cookie_preserve_param
*life
;
409 struct sctp_hostname_param
*dns
;
410 struct sctp_cookie_param
*cookie
;
411 struct sctp_supported_addrs_param
*sat
;
412 struct sctp_ipv4addr_param
*v4
;
413 struct sctp_ipv6addr_param
*v6
;
414 union sctp_addr_param
*addr
;
415 struct sctp_adaption_ind_param
*aind
;
418 /* RFC 2960. Section 3.3.5 Heartbeat.
419 * Heartbeat Information: variable length
420 * The Sender-specific Heartbeat Info field should normally include
421 * information about the sender's current time when this HEARTBEAT
422 * chunk is sent and the destination transport address to which this
423 * HEARTBEAT is sent (see Section 8.3).
425 typedef struct sctp_sender_hb_info
{
426 struct sctp_paramhdr param_hdr
;
427 union sctp_addr daddr
;
428 unsigned long sent_at
;
429 } __attribute__((packed
)) sctp_sender_hb_info_t
;
432 * RFC 2960 1.3.2 Sequenced Delivery within Streams
434 * The term "stream" is used in SCTP to refer to a sequence of user
435 * messages that are to be delivered to the upper-layer protocol in
436 * order with respect to other messages within the same stream. This is
437 * in contrast to its usage in TCP, where it refers to a sequence of
438 * bytes (in this document a byte is assumed to be eight bits).
441 * This is the structure we use to track both our outbound and inbound
442 * SSN, or Stream Sequence Numbers.
451 struct sctp_stream in
;
452 struct sctp_stream out
;
456 struct sctp_ssnmap
*sctp_ssnmap_new(__u16 in
, __u16 out
,
458 void sctp_ssnmap_free(struct sctp_ssnmap
*map
);
459 void sctp_ssnmap_clear(struct sctp_ssnmap
*map
);
461 /* What is the current SSN number for this stream? */
462 static inline __u16
sctp_ssn_peek(struct sctp_stream
*stream
, __u16 id
)
464 return stream
->ssn
[id
];
467 /* Return the next SSN number for this stream. */
468 static inline __u16
sctp_ssn_next(struct sctp_stream
*stream
, __u16 id
)
470 return stream
->ssn
[id
]++;
473 /* Skip over this ssn and all below. */
474 static inline void sctp_ssn_skip(struct sctp_stream
*stream
, __u16 id
,
477 stream
->ssn
[id
] = ssn
+1;
481 * Pointers to address related SCTP functions.
482 * (i.e. things that depend on the address family.)
485 int (*sctp_xmit
) (struct sk_buff
*skb
,
486 struct sctp_transport
*,
488 int (*setsockopt
) (struct sock
*sk
,
493 int (*getsockopt
) (struct sock
*sk
,
498 struct dst_entry
*(*get_dst
) (struct sctp_association
*asoc
,
499 union sctp_addr
*daddr
,
500 union sctp_addr
*saddr
);
501 void (*get_saddr
) (struct sctp_association
*asoc
,
502 struct dst_entry
*dst
,
503 union sctp_addr
*daddr
,
504 union sctp_addr
*saddr
);
505 void (*copy_addrlist
) (struct list_head
*,
506 struct net_device
*);
507 void (*dst_saddr
) (union sctp_addr
*saddr
,
508 struct dst_entry
*dst
,
509 unsigned short port
);
510 int (*cmp_addr
) (const union sctp_addr
*addr1
,
511 const union sctp_addr
*addr2
);
512 void (*addr_copy
) (union sctp_addr
*dst
,
513 union sctp_addr
*src
);
514 void (*from_skb
) (union sctp_addr
*,
517 void (*from_sk
) (union sctp_addr
*,
519 void (*to_sk_saddr
) (union sctp_addr
*,
521 void (*to_sk_daddr
) (union sctp_addr
*,
523 void (*from_addr_param
) (union sctp_addr
*,
524 union sctp_addr_param
*,
525 __u16 port
, int iif
);
526 int (*to_addr_param
) (const union sctp_addr
*,
527 union sctp_addr_param
*);
528 int (*addr_valid
) (union sctp_addr
*,
530 sctp_scope_t (*scope
) (union sctp_addr
*);
531 void (*inaddr_any
) (union sctp_addr
*, unsigned short);
532 int (*is_any
) (const union sctp_addr
*);
533 int (*available
) (union sctp_addr
*,
535 int (*skb_iif
) (const struct sk_buff
*sk
);
536 int (*is_ce
) (const struct sk_buff
*sk
);
537 void (*seq_dump_addr
)(struct seq_file
*seq
,
538 union sctp_addr
*addr
);
539 __u16 net_header_len
;
541 sa_family_t sa_family
;
542 struct list_head list
;
545 struct sctp_af
*sctp_get_af_specific(sa_family_t
);
546 int sctp_register_af(struct sctp_af
*);
548 /* Protocol family functions. */
550 void (*event_msgname
)(struct sctp_ulpevent
*, char *, int *);
551 void (*skb_msgname
) (struct sk_buff
*, char *, int *);
552 int (*af_supported
) (sa_family_t
, struct sctp_sock
*);
553 int (*cmp_addr
) (const union sctp_addr
*,
554 const union sctp_addr
*,
556 int (*bind_verify
) (struct sctp_sock
*, union sctp_addr
*);
557 int (*send_verify
) (struct sctp_sock
*, union sctp_addr
*);
558 int (*supported_addrs
)(const struct sctp_sock
*, __u16
*);
559 struct sock
*(*create_accept_sk
) (struct sock
*sk
,
560 struct sctp_association
*asoc
);
561 void (*addr_v4map
) (struct sctp_sock
*, union sctp_addr
*);
566 /* Structure to track chunk fragments that have been acked, but peer
567 * fragments of the same message have not.
569 struct sctp_datamsg
{
570 /* Chunks waiting to be submitted to lower layer. */
571 struct list_head chunks
;
572 /* Chunks that have been transmitted. */
573 struct list_head track
;
574 /* Reference counting. */
576 /* When is this message no longer interesting to the peer? */
577 unsigned long expires_at
;
578 /* Did the messenge fail to send? */
581 /* Control whether chunks from this message can be abandoned. */
585 struct sctp_datamsg
*sctp_datamsg_from_user(struct sctp_association
*,
586 struct sctp_sndrcvinfo
*,
587 struct msghdr
*, int len
);
588 void sctp_datamsg_put(struct sctp_datamsg
*);
589 void sctp_datamsg_free(struct sctp_datamsg
*);
590 void sctp_datamsg_track(struct sctp_chunk
*);
591 void sctp_chunk_fail(struct sctp_chunk
*, int error
);
592 int sctp_chunk_abandoned(struct sctp_chunk
*);
594 /* RFC2960 1.4 Key Terms
596 * o Chunk: A unit of information within an SCTP packet, consisting of
597 * a chunk header and chunk-specific content.
599 * As a matter of convenience, we remember the SCTP common header for
600 * each chunk as well as a few other header pointers...
603 struct list_head list
;
607 /* This is our link to the per-transport transmitted list. */
608 struct list_head transmitted_list
;
610 /* This field is used by chunks that hold fragmented data.
611 * For the first fragment this is the list that holds the rest of
612 * fragments. For the remaining fragments, this is the link to the
613 * frag_list maintained in the first fragment.
615 struct list_head frag_list
;
617 /* This points to the sk_buff containing the actual data. */
620 /* These are the SCTP headers by reverse order in a packet.
621 * Note that some of these may happen more than once. In that
622 * case, we point at the "current" one, whatever that means
623 * for that level of header.
626 /* We point this at the FIRST TLV parameter to chunk_hdr. */
627 union sctp_params param_hdr
;
630 struct sctp_datahdr
*data_hdr
;
631 struct sctp_inithdr
*init_hdr
;
632 struct sctp_sackhdr
*sack_hdr
;
633 struct sctp_heartbeathdr
*hb_hdr
;
634 struct sctp_sender_hb_info
*hbs_hdr
;
635 struct sctp_shutdownhdr
*shutdown_hdr
;
636 struct sctp_signed_cookie
*cookie_hdr
;
637 struct sctp_ecnehdr
*ecne_hdr
;
638 struct sctp_cwrhdr
*ecn_cwr_hdr
;
639 struct sctp_errhdr
*err_hdr
;
640 struct sctp_addiphdr
*addip_hdr
;
641 struct sctp_fwdtsn_hdr
*fwdtsn_hdr
;
646 struct sctp_chunkhdr
*chunk_hdr
;
647 struct sctphdr
*sctp_hdr
;
649 /* This needs to be recoverable for SCTP_SEND_FAILED events. */
650 struct sctp_sndrcvinfo sinfo
;
652 /* Which association does this belong to? */
653 struct sctp_association
*asoc
;
655 /* What endpoint received this chunk? */
656 struct sctp_ep_common
*rcvr
;
658 /* We fill this in if we are calculating RTT. */
659 unsigned long sent_at
;
661 /* What is the origin IP address for this chunk? */
662 union sctp_addr source
;
663 /* Destination address for this chunk. */
664 union sctp_addr dest
;
666 /* For outbound message, track all fragments for SEND_FAILED. */
667 struct sctp_datamsg
*msg
;
669 /* For an inbound chunk, this tells us where it came from.
670 * For an outbound chunk, it tells us where we'd like it to
671 * go. It is NULL if we have no preference.
673 struct sctp_transport
*transport
;
675 __u8 rtt_in_progress
; /* Is this chunk used for RTT calculation? */
676 __u8 resent
; /* Has this chunk ever been retransmitted. */
677 __u8 has_tsn
; /* Does this chunk have a TSN yet? */
678 __u8 has_ssn
; /* Does this chunk have a SSN yet? */
679 __u8 singleton
; /* Was this the only chunk in the packet? */
680 __u8 end_of_packet
; /* Was this the last chunk in the packet? */
681 __u8 ecn_ce_done
; /* Have we processed the ECN CE bit? */
682 __u8 pdiscard
; /* Discard the whole packet now? */
683 __u8 tsn_gap_acked
; /* Is this chunk acked by a GAP ACK? */
684 __u8 fast_retransmit
; /* Is this chunk fast retransmitted? */
685 __u8 tsn_missing_report
; /* Data chunk missing counter. */
688 void sctp_chunk_hold(struct sctp_chunk
*);
689 void sctp_chunk_put(struct sctp_chunk
*);
690 int sctp_user_addto_chunk(struct sctp_chunk
*chunk
, int off
, int len
,
692 void sctp_chunk_free(struct sctp_chunk
*);
693 void *sctp_addto_chunk(struct sctp_chunk
*, int len
, const void *data
);
694 struct sctp_chunk
*sctp_chunkify(struct sk_buff
*,
695 const struct sctp_association
*,
697 void sctp_init_addrs(struct sctp_chunk
*, union sctp_addr
*,
699 const union sctp_addr
*sctp_source(const struct sctp_chunk
*chunk
);
701 /* This is a structure for holding either an IPv6 or an IPv4 address. */
702 /* sin_family -- AF_INET or AF_INET6
703 * sin_port -- ordinary port number
704 * sin_addr -- cast to either (struct in_addr) or (struct in6_addr)
706 struct sctp_sockaddr_entry
{
707 struct list_head list
;
711 typedef struct sctp_chunk
*(sctp_packet_phandler_t
)(struct sctp_association
*);
713 /* This structure holds lists of chunks as we are assembling for
717 /* These are the SCTP header values (host order) for the packet. */
719 __u16 destination_port
;
722 /* This contains the payload chunks. */
723 struct list_head chunk_list
;
725 /* This is the overhead of the sctp and ip headers. */
727 /* This is the total size of all chunks INCLUDING padding. */
730 /* The packet is destined for this transport address.
731 * The function we finally use to pass down to the next lower
732 * layer lives in the transport structure.
734 struct sctp_transport
*transport
;
736 /* This packet contains a COOKIE-ECHO chunk. */
737 char has_cookie_echo
;
739 /* This packet containsa SACK chunk. */
742 /* SCTP cannot fragment this packet. So let ip fragment it. */
748 struct sctp_packet
*sctp_packet_init(struct sctp_packet
*,
749 struct sctp_transport
*,
750 __u16 sport
, __u16 dport
);
751 struct sctp_packet
*sctp_packet_config(struct sctp_packet
*, __u32 vtag
, int);
752 sctp_xmit_t
sctp_packet_transmit_chunk(struct sctp_packet
*,
753 struct sctp_chunk
*);
754 sctp_xmit_t
sctp_packet_append_chunk(struct sctp_packet
*,
755 struct sctp_chunk
*);
756 int sctp_packet_transmit(struct sctp_packet
*);
757 void sctp_packet_free(struct sctp_packet
*);
759 static inline int sctp_packet_empty(struct sctp_packet
*packet
)
761 return (packet
->size
== packet
->overhead
);
764 /* This represents a remote transport address.
765 * For local transport addresses, we just use union sctp_addr.
767 * RFC2960 Section 1.4 Key Terms
769 * o Transport address: A Transport Address is traditionally defined
770 * by Network Layer address, Transport Layer protocol and Transport
771 * Layer port number. In the case of SCTP running over IP, a
772 * transport address is defined by the combination of an IP address
773 * and an SCTP port number (where SCTP is the Transport protocol).
775 * RFC2960 Section 7.1 SCTP Differences from TCP Congestion control
777 * o The sender keeps a separate congestion control parameter set for
778 * each of the destination addresses it can send to (not each
779 * source-destination pair but for each destination). The parameters
780 * should decay if the address is not used for a long enough time
784 struct sctp_transport
{
785 /* A list of transports. */
786 struct list_head transports
;
788 /* Reference counting. */
792 /* This is the peer's IP address and port. */
793 union sctp_addr ipaddr
;
795 /* These are the functions we call to handle LLP stuff. */
796 struct sctp_af
*af_specific
;
798 /* Which association do we belong to? */
799 struct sctp_association
*asoc
;
803 * 12.3 Per Transport Address Data
805 * For each destination transport address in the peer's
806 * address list derived from the INIT or INIT ACK chunk, a
807 * number of data elements needs to be maintained including:
809 __u32 rtt
; /* This is the most recent RTT. */
811 /* RTO : The current retransmission timeout value. */
814 /* RTTVAR : The current RTT variation. */
817 /* SRTT : The current smoothed round trip time. */
820 /* RTO-Pending : A flag used to track if one of the DATA
821 * chunks sent to this address is currently being
822 * used to compute a RTT. If this flag is 0,
823 * the next DATA chunk sent to this destination
824 * should be used to compute a RTT and this flag
825 * should be set. Every time the RTT
826 * calculation completes (i.e. the DATA chunk
827 * is SACK'd) clear this flag.
832 * These are the congestion stats.
834 /* cwnd : The current congestion window. */
835 __u32 cwnd
; /* This is the actual cwnd. */
837 /* ssthresh : The current slow start threshold value. */
840 /* partial : The tracking method for increase of cwnd when in
841 * bytes acked : congestion avoidance mode (see Section 6.2.2)
843 __u32 partial_bytes_acked
;
845 /* Data that has been sent, but not acknowledged. */
848 /* PMTU : The current known path MTU. */
852 struct dst_entry
*dst
;
853 /* Source address. */
854 union sctp_addr saddr
;
856 /* When was the last time(in jiffies) that a data packet was sent on
857 * this transport? This is used to adjust the cwnd when the transport
860 unsigned long last_time_used
;
862 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
863 * the destination address every heartbeat interval.
867 /* When was the last time (in jiffies) that we heard from this
868 * transport? We use this to pick new active and retran paths.
870 unsigned long last_time_heard
;
872 /* Last time(in jiffies) when cwnd is reduced due to the congestion
873 * indication based on ECNE chunk.
875 unsigned long last_time_ecne_reduced
;
877 /* The number of times INIT has been sent on this transport. */
880 /* state : The current state of this destination,
881 * : i.e. SCTP_ACTIVE, SCTP_INACTIVE, SCTP_UNKOWN.
885 /* hb_allowed : The current heartbeat state of this destination,
886 * : i.e. ALLOW-HB, NO-HEARTBEAT, etc.
890 /* These are the error stats for this destination. */
892 /* Error count : The current error count for this destination. */
893 unsigned short error_count
;
895 /* This is the max_retrans value for the transport and will
896 * be initialized to proto.max_retrans.path. This can be changed
897 * using SCTP_SET_PEER_ADDR_PARAMS socket option.
901 /* Per : A timer used by each destination.
905 * [Everywhere else in the text this is called T3-rtx. -ed]
907 struct timer_list T3_rtx_timer
;
909 /* Heartbeat timer is per destination. */
910 struct timer_list hb_timer
;
912 /* Since we're using per-destination retransmission timers
913 * (see above), we're also using per-destination "transmitted"
914 * queues. This probably ought to be a private struct
915 * accessible only within the outqueue, but it's not, yet.
917 struct list_head transmitted
;
919 /* We build bundle-able packets for this transport here. */
920 struct sctp_packet packet
;
922 /* This is the list of transports that have chunks to send. */
923 struct list_head send_ready
;
925 int malloced
; /* Is this structure kfree()able? */
927 /* State information saved for SFR_CACC algorithm. The key
928 * idea in SFR_CACC is to maintain state at the sender on a
929 * per-destination basis when a changeover happens.
930 * char changeover_active;
931 * char cycling_changeover;
932 * __u32 next_tsn_at_change;
933 * char cacc_saw_newack;
936 /* An unsigned integer, which stores the next TSN to be
937 * used by the sender, at the moment of changeover.
939 __u32 next_tsn_at_change
;
941 /* A flag which indicates the occurrence of a changeover */
942 char changeover_active
;
944 /* A flag which indicates whether the change of primary is
945 * the first switch to this destination address during an
948 char cycling_changeover
;
950 /* A temporary flag, which is used during the processing of
951 * a SACK to estimate the causative TSN(s)'s group.
953 char cacc_saw_newack
;
957 struct sctp_transport
*sctp_transport_new(const union sctp_addr
*,
959 void sctp_transport_set_owner(struct sctp_transport
*,
960 struct sctp_association
*);
961 void sctp_transport_route(struct sctp_transport
*, union sctp_addr
*,
963 void sctp_transport_pmtu(struct sctp_transport
*);
964 void sctp_transport_free(struct sctp_transport
*);
965 void sctp_transport_reset_timers(struct sctp_transport
*);
966 void sctp_transport_hold(struct sctp_transport
*);
967 void sctp_transport_put(struct sctp_transport
*);
968 void sctp_transport_update_rto(struct sctp_transport
*, __u32
);
969 void sctp_transport_raise_cwnd(struct sctp_transport
*, __u32
, __u32
);
970 void sctp_transport_lower_cwnd(struct sctp_transport
*, sctp_lower_cwnd_t
);
971 unsigned long sctp_transport_timeout(struct sctp_transport
*);
974 /* This is the structure we use to queue packets as they come into
975 * SCTP. We write packets to it and read chunks from it.
978 /* This is actually a queue of sctp_chunk each
979 * containing a partially decoded packet.
981 struct list_head in_chunk_list
;
982 /* This is the packet which is currently off the in queue and is
983 * being worked on through the inbound chunk processing.
985 struct sctp_chunk
*in_progress
;
987 /* This is the delayed task to finish delivering inbound
990 struct work_struct immediate
;
992 int malloced
; /* Is this structure kfree()able? */
995 void sctp_inq_init(struct sctp_inq
*);
996 void sctp_inq_free(struct sctp_inq
*);
997 void sctp_inq_push(struct sctp_inq
*, struct sctp_chunk
*packet
);
998 struct sctp_chunk
*sctp_inq_pop(struct sctp_inq
*);
999 void sctp_inq_set_th_handler(struct sctp_inq
*, void (*)(void *), void *);
1001 /* This is the structure we use to hold outbound chunks. You push
1002 * chunks in and they automatically pop out the other end as bundled
1003 * packets (it calls (*output_handler)()).
1005 * This structure covers sections 6.3, 6.4, 6.7, 6.8, 6.10, 7., 8.1,
1006 * and 8.2 of the v13 draft.
1008 * It handles retransmissions. The connection to the timeout portion
1009 * of the state machine is through sctp_..._timeout() and timeout_handler.
1011 * If you feed it SACKs, it will eat them.
1013 * If you give it big chunks, it will fragment them.
1015 * It assigns TSN's to data chunks. This happens at the last possible
1016 * instant before transmission.
1018 * When free()'d, it empties itself out via output_handler().
1021 struct sctp_association
*asoc
;
1023 /* Data pending that has never been transmitted. */
1024 struct list_head out_chunk_list
;
1026 unsigned out_qlen
; /* Total length of queued data chunks. */
1028 /* Error of send failed, may used in SCTP_SEND_FAILED event. */
1031 /* These are control chunks we want to send. */
1032 struct list_head control_chunk_list
;
1034 /* These are chunks that have been sacked but are above the
1035 * CTSN, or cumulative tsn ack point.
1037 struct list_head sacked
;
1039 /* Put chunks on this list to schedule them for
1042 struct list_head retransmit
;
1044 /* Put chunks on this list to save them for FWD TSN processing as
1045 * they were abandoned.
1047 struct list_head abandoned
;
1049 /* How many unackd bytes do we have in-flight? */
1050 __u32 outstanding_bytes
;
1055 /* Is this structure empty? */
1058 /* Are we kfree()able? */
1062 void sctp_outq_init(struct sctp_association
*, struct sctp_outq
*);
1063 void sctp_outq_teardown(struct sctp_outq
*);
1064 void sctp_outq_free(struct sctp_outq
*);
1065 int sctp_outq_tail(struct sctp_outq
*, struct sctp_chunk
*chunk
);
1066 int sctp_outq_flush(struct sctp_outq
*, int);
1067 int sctp_outq_sack(struct sctp_outq
*, struct sctp_sackhdr
*);
1068 int sctp_outq_is_empty(const struct sctp_outq
*);
1069 void sctp_outq_restart(struct sctp_outq
*);
1071 void sctp_retransmit(struct sctp_outq
*, struct sctp_transport
*,
1072 sctp_retransmit_reason_t
);
1073 void sctp_retransmit_mark(struct sctp_outq
*, struct sctp_transport
*, __u8
);
1074 int sctp_outq_uncork(struct sctp_outq
*);
1075 /* Uncork and flush an outqueue. */
1076 static inline void sctp_outq_cork(struct sctp_outq
*q
)
1081 /* These bind address data fields common between endpoints and associations */
1082 struct sctp_bind_addr
{
1084 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1086 * SCTP Port: The local SCTP port number the endpoint is
1091 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1093 * Address List: The list of IP addresses that this instance
1094 * has bound. This information is passed to one's
1095 * peer(s) in INIT and INIT ACK chunks.
1097 struct list_head address_list
;
1099 int malloced
; /* Are we kfree()able? */
1102 void sctp_bind_addr_init(struct sctp_bind_addr
*, __u16 port
);
1103 void sctp_bind_addr_free(struct sctp_bind_addr
*);
1104 int sctp_bind_addr_copy(struct sctp_bind_addr
*dest
,
1105 const struct sctp_bind_addr
*src
,
1106 sctp_scope_t scope
, gfp_t gfp
,
1108 int sctp_add_bind_addr(struct sctp_bind_addr
*, union sctp_addr
*,
1110 int sctp_del_bind_addr(struct sctp_bind_addr
*, union sctp_addr
*);
1111 int sctp_bind_addr_match(struct sctp_bind_addr
*, const union sctp_addr
*,
1112 struct sctp_sock
*);
1113 union sctp_addr
*sctp_find_unmatch_addr(struct sctp_bind_addr
*bp
,
1114 const union sctp_addr
*addrs
,
1116 struct sctp_sock
*opt
);
1117 union sctp_params
sctp_bind_addrs_to_raw(const struct sctp_bind_addr
*bp
,
1120 int sctp_raw_to_bind_addrs(struct sctp_bind_addr
*bp
, __u8
*raw
, int len
,
1121 __u16 port
, gfp_t gfp
);
1123 sctp_scope_t
sctp_scope(const union sctp_addr
*);
1124 int sctp_in_scope(const union sctp_addr
*addr
, const sctp_scope_t scope
);
1125 int sctp_is_any(const union sctp_addr
*addr
);
1126 int sctp_addr_is_valid(const union sctp_addr
*addr
);
1129 /* What type of endpoint? */
1131 SCTP_EP_TYPE_SOCKET
,
1132 SCTP_EP_TYPE_ASSOCIATION
,
1133 } sctp_endpoint_type_t
;
1136 * A common base class to bridge the implmentation view of a
1137 * socket (usually listening) endpoint versus an association's
1139 * This common structure is useful for several purposes:
1140 * 1) Common interface for lookup routines.
1141 * a) Subfunctions work for either endpoint or association
1142 * b) Single interface to lookup allows hiding the lookup lock rather
1143 * than acquiring it externally.
1144 * 2) Common interface for the inbound chunk handling/state machine.
1145 * 3) Common object handling routines for reference counting, etc.
1146 * 4) Disentangle association lookup from endpoint lookup, where we
1147 * do not have to find our endpoint to find our association.
1151 struct sctp_ep_common
{
1152 /* Fields to help us manage our entries in the hash tables. */
1153 struct sctp_ep_common
*next
;
1154 struct sctp_ep_common
**pprev
;
1157 /* Runtime type information. What kind of endpoint is this? */
1158 sctp_endpoint_type_t type
;
1160 /* Some fields to help us manage this object.
1161 * refcnt - Reference count access to this object.
1162 * dead - Do not attempt to use this object.
1163 * malloced - Do we need to kfree this object?
1169 /* What socket does this endpoint belong to? */
1172 /* This is where we receive inbound chunks. */
1173 struct sctp_inq inqueue
;
1175 /* This substructure includes the defining parameters of the
1177 * bind_addr.port is our shared port number.
1178 * bind_addr.address_list is our set of local IP addresses.
1180 struct sctp_bind_addr bind_addr
;
1182 /* Protection during address list comparisons. */
1187 /* RFC Section 1.4 Key Terms
1189 * o SCTP endpoint: The logical sender/receiver of SCTP packets. On a
1190 * multi-homed host, an SCTP endpoint is represented to its peers as a
1191 * combination of a set of eligible destination transport addresses to
1192 * which SCTP packets can be sent and a set of eligible source
1193 * transport addresses from which SCTP packets can be received.
1194 * All transport addresses used by an SCTP endpoint must use the
1195 * same port number, but can use multiple IP addresses. A transport
1196 * address used by an SCTP endpoint must not be used by another
1197 * SCTP endpoint. In other words, a transport address is unique
1198 * to an SCTP endpoint.
1200 * From an implementation perspective, each socket has one of these.
1201 * A TCP-style socket will have exactly one association on one of
1202 * these. An UDP-style socket will have multiple associations hanging
1206 struct sctp_endpoint
{
1207 /* Common substructure for endpoint and association. */
1208 struct sctp_ep_common base
;
1210 /* Associations: A list of current associations and mappings
1211 * to the data consumers for each association. This
1212 * may be in the form of a hash table or other
1213 * implementation dependent structure. The data
1214 * consumers may be process identification
1215 * information such as file descriptors, named pipe
1216 * pointer, or table pointers dependent on how SCTP
1219 /* This is really a list of struct sctp_association entries. */
1220 struct list_head asocs
;
1222 /* Secret Key: A secret key used by this endpoint to compute
1223 * the MAC. This SHOULD be a cryptographic quality
1224 * random number with a sufficient length.
1225 * Discussion in [RFC1750] can be helpful in
1226 * selection of the key.
1228 __u8 secret_key
[SCTP_HOW_MANY_SECRETS
][SCTP_SECRET_SIZE
];
1233 /* sendbuf acct. policy. */
1234 __u32 sndbuf_policy
;
1236 /* rcvbuf acct. policy. */
1237 __u32 rcvbuf_policy
;
1240 /* Recover the outter endpoint structure. */
1241 static inline struct sctp_endpoint
*sctp_ep(struct sctp_ep_common
*base
)
1243 struct sctp_endpoint
*ep
;
1245 ep
= container_of(base
, struct sctp_endpoint
, base
);
1249 /* These are function signatures for manipulating endpoints. */
1250 struct sctp_endpoint
*sctp_endpoint_new(struct sock
*, gfp_t
);
1251 void sctp_endpoint_free(struct sctp_endpoint
*);
1252 void sctp_endpoint_put(struct sctp_endpoint
*);
1253 void sctp_endpoint_hold(struct sctp_endpoint
*);
1254 void sctp_endpoint_add_asoc(struct sctp_endpoint
*, struct sctp_association
*);
1255 struct sctp_association
*sctp_endpoint_lookup_assoc(
1256 const struct sctp_endpoint
*ep
,
1257 const union sctp_addr
*paddr
,
1258 struct sctp_transport
**);
1259 int sctp_endpoint_is_peeled_off(struct sctp_endpoint
*,
1260 const union sctp_addr
*);
1261 struct sctp_endpoint
*sctp_endpoint_is_match(struct sctp_endpoint
*,
1262 const union sctp_addr
*);
1263 int sctp_has_association(const union sctp_addr
*laddr
,
1264 const union sctp_addr
*paddr
);
1266 int sctp_verify_init(const struct sctp_association
*asoc
, sctp_cid_t
,
1267 sctp_init_chunk_t
*peer_init
, struct sctp_chunk
*chunk
,
1268 struct sctp_chunk
**err_chunk
);
1269 int sctp_process_init(struct sctp_association
*, sctp_cid_t cid
,
1270 const union sctp_addr
*peer
,
1271 sctp_init_chunk_t
*init
, gfp_t gfp
);
1272 __u32
sctp_generate_tag(const struct sctp_endpoint
*);
1273 __u32
sctp_generate_tsn(const struct sctp_endpoint
*);
1278 * 12. Recommended Transmission Control Block (TCB) Parameters
1280 * This section details a recommended set of parameters that should
1281 * be contained within the TCB for an implementation. This section is
1282 * for illustrative purposes and should not be deemed as requirements
1283 * on an implementation or as an exhaustive list of all parameters
1284 * inside an SCTP TCB. Each implementation may need its own additional
1285 * parameters for optimization.
1289 /* Here we have information about each individual association. */
1290 struct sctp_association
{
1292 /* A base structure common to endpoint and association.
1293 * In this context, it represents the associations's view
1294 * of the local endpoint of the association.
1296 struct sctp_ep_common base
;
1298 /* Associations on the same socket. */
1299 struct list_head asocs
;
1301 /* association id. */
1302 sctp_assoc_t assoc_id
;
1304 /* This is our parent endpoint. */
1305 struct sctp_endpoint
*ep
;
1307 /* These are those association elements needed in the cookie. */
1308 struct sctp_cookie c
;
1310 /* This is all information about our peer. */
1314 * Peer Rwnd : Current calculated value of the peer's rwnd.
1318 /* transport_addr_list
1320 * Peer : A list of SCTP transport addresses that the
1321 * Transport : peer is bound to. This information is derived
1322 * Address : from the INIT or INIT ACK and is used to
1323 * List : associate an inbound packet with a given
1324 * : association. Normally this information is
1325 * : hashed or keyed for quick lookup and access
1327 * : The list is also initialized with the list
1328 * : of addresses passed with the sctp_connectx()
1331 * It is a list of SCTP_transport's.
1333 struct list_head transport_addr_list
;
1337 * Peer : A count of the number of peer addresses
1338 * Transport : in the Peer Transport Address List.
1342 __u16 transport_count
;
1345 * The transport layer port number.
1351 * Primary : This is the current primary destination
1352 * Path : transport address of the peer endpoint. It
1353 * : may also specify a source transport address
1354 * : on this endpoint.
1356 * All of these paths live on transport_addr_list.
1358 * At the bakeoffs, we discovered that the intent of
1359 * primaryPath is that it only changes when the ULP
1360 * asks to have it changed. We add the activePath to
1361 * designate the connection we are currently using to
1362 * transmit new data and most control chunks.
1364 struct sctp_transport
*primary_path
;
1366 /* Cache the primary path address here, when we
1367 * need a an address for msg_name.
1369 union sctp_addr primary_addr
;
1372 * The path that we are currently using to
1373 * transmit new data and most control chunks.
1375 struct sctp_transport
*active_path
;
1379 * RFC2960 6.4 Multi-homed SCTP Endpoints
1381 * Furthermore, when its peer is multi-homed, an
1382 * endpoint SHOULD try to retransmit a chunk to an
1383 * active destination transport address that is
1384 * different from the last destination address to
1385 * which the DATA chunk was sent.
1387 struct sctp_transport
*retran_path
;
1389 /* Pointer to last transport I have sent on. */
1390 struct sctp_transport
*last_sent_to
;
1392 /* This is the last transport I have received DATA on. */
1393 struct sctp_transport
*last_data_from
;
1396 * Mapping An array of bits or bytes indicating which out of
1397 * Array order TSN's have been received (relative to the
1398 * Last Rcvd TSN). If no gaps exist, i.e. no out of
1399 * order packets have been received, this array
1400 * will be set to all zero. This structure may be
1401 * in the form of a circular buffer or bit array.
1403 * Last Rcvd : This is the last TSN received in
1404 * TSN : sequence. This value is set initially by
1405 * : taking the peer's Initial TSN, received in
1406 * : the INIT or INIT ACK chunk, and subtracting
1409 * Throughout most of the specification this is called the
1410 * "Cumulative TSN ACK Point". In this case, we
1411 * ignore the advice in 12.2 in favour of the term
1412 * used in the bulk of the text. This value is hidden
1413 * in tsn_map--we get it by calling sctp_tsnmap_get_ctsn().
1415 struct sctp_tsnmap tsn_map
;
1416 __u8 _map
[sctp_tsnmap_storage_size(SCTP_TSN_MAP_SIZE
)];
1418 /* Ack State : This flag indicates if the next received
1419 * : packet is to be responded to with a
1420 * : SACK. This is initializedto 0. When a packet
1421 * : is received it is incremented. If this value
1422 * : reaches 2 or more, a SACK is sent and the
1423 * : value is reset to 0. Note: This is used only
1424 * : when no DATA chunks are received out of
1425 * : order. When DATA chunks are out of order,
1426 * : SACK's are not delayed (see Section 6).
1428 __u8 sack_needed
; /* Do we need to sack the peer? */
1430 /* These are capabilities which our peer advertised. */
1431 __u8 ecn_capable
; /* Can peer do ECN? */
1432 __u8 ipv4_address
; /* Peer understands IPv4 addresses? */
1433 __u8 ipv6_address
; /* Peer understands IPv6 addresses? */
1434 __u8 hostname_address
;/* Peer understands DNS addresses? */
1435 __u8 asconf_capable
; /* Does peer support ADDIP? */
1436 __u8 prsctp_capable
; /* Can peer do PR-SCTP? */
1438 __u32 adaption_ind
; /* Adaption Code point. */
1440 /* This mask is used to disable sending the ASCONF chunk
1441 * with specified parameter to peer.
1443 __u16 addip_disabled_mask
;
1445 struct sctp_inithdr i
;
1449 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
1450 * C1) ... "Peer-Serial-Number'. This value MUST be initialized to the
1451 * Initial TSN Value minus 1
1456 /* State : A state variable indicating what state the
1457 * : association is in, i.e. COOKIE-WAIT,
1458 * : COOKIE-ECHOED, ESTABLISHED, SHUTDOWN-PENDING,
1459 * : SHUTDOWN-SENT, SHUTDOWN-RECEIVED, SHUTDOWN-ACK-SENT.
1461 * Note: No "CLOSED" state is illustrated since if a
1462 * association is "CLOSED" its TCB SHOULD be removed.
1464 * In this implementation we DO have a CLOSED
1465 * state which is used during initiation and shutdown.
1467 * State takes values from SCTP_STATE_*.
1471 /* The cookie life I award for any cookie. */
1472 struct timeval cookie_life
;
1474 /* Overall : The overall association error count.
1475 * Error Count : [Clear this any time I get something.]
1477 int overall_error_count
;
1479 /* These are the association's initial, max, and min RTO values.
1480 * These values will be initialized by system defaults, but can
1481 * be modified via the SCTP_RTOINFO socket option.
1487 /* Maximum number of new data packets that can be sent in a burst. */
1490 /* This is the max_retrans value for the association. This value will
1491 * be initialized initialized from system defaults, but can be
1492 * modified by the SCTP_ASSOCINFO socket option.
1496 /* Maximum number of times the endpoint will retransmit INIT */
1497 __u16 max_init_attempts
;
1499 /* How many times have we resent an INIT? */
1502 /* The largest timeout or RTO value to use in attempting an INIT */
1503 __u16 max_init_timeo
;
1505 int timeouts
[SCTP_NUM_TIMEOUT_TYPES
];
1506 struct timer_list timers
[SCTP_NUM_TIMEOUT_TYPES
];
1508 /* Transport to which SHUTDOWN chunk was last sent. */
1509 struct sctp_transport
*shutdown_last_sent_to
;
1511 /* Transport to which INIT chunk was last sent. */
1512 struct sctp_transport
*init_last_sent_to
;
1514 /* Next TSN : The next TSN number to be assigned to a new
1515 * : DATA chunk. This is sent in the INIT or INIT
1516 * : ACK chunk to the peer and incremented each
1517 * : time a DATA chunk is assigned a TSN
1518 * : (normally just prior to transmit or during
1524 * Last Rcvd : This is the last TSN received in sequence. This value
1525 * TSN : is set initially by taking the peer's Initial TSN,
1526 * : received in the INIT or INIT ACK chunk, and
1527 * : subtracting one from it.
1529 * Most of RFC 2960 refers to this as the Cumulative TSN Ack Point.
1532 __u32 ctsn_ack_point
;
1534 /* PR-SCTP Advanced.Peer.Ack.Point */
1535 __u32 adv_peer_ack_point
;
1537 /* Highest TSN that is acknowledged by incoming SACKs. */
1538 __u32 highest_sacked
;
1540 /* The number of unacknowledged data chunks. Reported through
1541 * the SCTP_STATUS sockopt.
1545 /* This is the association's receive buffer space. This value is used
1546 * to set a_rwnd field in an INIT or a SACK chunk.
1550 /* This is the last advertised value of rwnd over a SACK chunk. */
1553 /* Number of bytes by which the rwnd has slopped. The rwnd is allowed
1554 * to slop over a maximum of the association's frag_point.
1558 /* This is the sndbuf size in use for the association.
1559 * This corresponds to the sndbuf size for the association,
1560 * as specified in the sk->sndbuf.
1564 /* This is the amount of memory that this association has allocated
1565 * in the receive path at any given time.
1567 atomic_t rmem_alloc
;
1569 /* This is the wait queue head for send requests waiting on
1570 * the association sndbuf space.
1572 wait_queue_head_t wait
;
1574 /* Association : The smallest PMTU discovered for all of the
1575 * PMTU : peer's transport addresses.
1579 /* The message size at which SCTP fragmentation will occur. */
1582 /* Counter used to count INIT errors. */
1583 int init_err_counter
;
1585 /* Count the number of INIT cycles (for doubling timeout). */
1588 /* Default send parameters. */
1589 __u16 default_stream
;
1590 __u16 default_flags
;
1592 __u32 default_context
;
1593 __u32 default_timetolive
;
1595 /* This tracks outbound ssn for a given stream. */
1596 struct sctp_ssnmap
*ssnmap
;
1598 /* All outbound chunks go through this structure. */
1599 struct sctp_outq outqueue
;
1601 /* A smart pipe that will handle reordering and fragmentation,
1602 * as well as handle passing events up to the ULP.
1604 struct sctp_ulpq ulpq
;
1606 /* Last TSN that caused an ECNE Chunk to be sent. */
1607 __u32 last_ecne_tsn
;
1609 /* Last TSN that caused a CWR Chunk to be sent. */
1612 /* How many duplicated TSNs have we seen? */
1615 /* Number of seconds of idle time before an association is closed. */
1618 /* These are to support
1619 * "SCTP Extensions for Dynamic Reconfiguration of IP Addresses
1620 * and Enforcement of Flow and Message Limits"
1621 * <draft-ietf-tsvwg-addip-sctp-02.txt>
1622 * or "ADDIP" for short.
1627 /* ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1629 * R1) One and only one ASCONF Chunk MAY be in transit and
1630 * unacknowledged at any one time. If a sender, after sending
1631 * an ASCONF chunk, decides it needs to transfer another
1632 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1633 * returns from the previous ASCONF Chunk before sending a
1634 * subsequent ASCONF. Note this restriction binds each side,
1635 * so at any time two ASCONF may be in-transit on any given
1636 * association (one sent from each endpoint).
1638 * [This is our one-and-only-one ASCONF in flight. If we do
1639 * not have an ASCONF in flight, this is NULL.]
1641 struct sctp_chunk
*addip_last_asconf
;
1643 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
1645 * IMPLEMENTATION NOTE: As an optimization a receiver may wish
1646 * to save the last ASCONF-ACK for some predetermined period
1647 * of time and instead of re-processing the ASCONF (with the
1648 * same serial number) it may just re-transmit the
1649 * ASCONF-ACK. It may wish to use the arrival of a new serial
1650 * number to discard the previously saved ASCONF-ACK or any
1651 * other means it may choose to expire the saved ASCONF-ACK.
1653 * [This is our saved ASCONF-ACK. We invalidate it when a new
1654 * ASCONF serial number arrives.]
1656 struct sctp_chunk
*addip_last_asconf_ack
;
1658 /* These ASCONF chunks are waiting to be sent.
1660 * These chunaks can't be pushed to outqueue until receiving
1661 * ASCONF_ACK for the previous ASCONF indicated by
1662 * addip_last_asconf, so as to guarantee that only one ASCONF
1663 * is in flight at any time.
1665 * ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1667 * In defining the ASCONF Chunk transfer procedures, it is
1668 * essential that these transfers MUST NOT cause congestion
1669 * within the network. To achieve this, we place these
1670 * restrictions on the transfer of ASCONF Chunks:
1672 * R1) One and only one ASCONF Chunk MAY be in transit and
1673 * unacknowledged at any one time. If a sender, after sending
1674 * an ASCONF chunk, decides it needs to transfer another
1675 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1676 * returns from the previous ASCONF Chunk before sending a
1677 * subsequent ASCONF. Note this restriction binds each side,
1678 * so at any time two ASCONF may be in-transit on any given
1679 * association (one sent from each endpoint).
1682 * [I really think this is EXACTLY the sort of intelligence
1683 * which already resides in sctp_outq. Please move this
1684 * queue and its supporting logic down there. --piggy]
1686 struct list_head addip_chunk_list
;
1688 /* ADDIP Section 4.1 ASCONF Chunk Procedures
1690 * A2) A serial number should be assigned to the Chunk. The
1691 * serial number SHOULD be a monotonically increasing
1692 * number. The serial number SHOULD be initialized at
1693 * the start of the association to the same value as the
1694 * Initial TSN and every time a new ASCONF chunk is created
1695 * it is incremented by one after assigning the serial number
1696 * to the newly created chunk.
1699 * 3.1.1 Address/Stream Configuration Change Chunk (ASCONF)
1701 * Serial Number : 32 bits (unsigned integer)
1703 * This value represents a Serial Number for the ASCONF
1704 * Chunk. The valid range of Serial Number is from 0 to
1705 * 4294967295 (2^32 - 1). Serial Numbers wrap back to 0
1706 * after reaching 4294967295.
1710 /* Need to send an ECNE Chunk? */
1713 /* Is it a temporary association? */
1718 /* An eyecatcher for determining if we are really looking at an
1719 * association data structure.
1722 SCTP_ASSOC_EYECATCHER
= 0xa550c123,
1725 /* Recover the outter association structure. */
1726 static inline struct sctp_association
*sctp_assoc(struct sctp_ep_common
*base
)
1728 struct sctp_association
*asoc
;
1730 asoc
= container_of(base
, struct sctp_association
, base
);
1734 /* These are function signatures for manipulating associations. */
1737 struct sctp_association
*
1738 sctp_association_new(const struct sctp_endpoint
*, const struct sock
*,
1739 sctp_scope_t scope
, gfp_t gfp
);
1740 void sctp_association_free(struct sctp_association
*);
1741 void sctp_association_put(struct sctp_association
*);
1742 void sctp_association_hold(struct sctp_association
*);
1744 struct sctp_transport
*sctp_assoc_choose_init_transport(
1745 struct sctp_association
*);
1746 struct sctp_transport
*sctp_assoc_choose_shutdown_transport(
1747 struct sctp_association
*);
1748 void sctp_assoc_update_retran_path(struct sctp_association
*);
1749 struct sctp_transport
*sctp_assoc_lookup_paddr(const struct sctp_association
*,
1750 const union sctp_addr
*);
1751 int sctp_assoc_lookup_laddr(struct sctp_association
*asoc
,
1752 const union sctp_addr
*laddr
);
1753 struct sctp_transport
*sctp_assoc_add_peer(struct sctp_association
*,
1754 const union sctp_addr
*address
,
1756 const int peer_state
);
1757 void sctp_assoc_del_peer(struct sctp_association
*asoc
,
1758 const union sctp_addr
*addr
);
1759 void sctp_assoc_rm_peer(struct sctp_association
*asoc
,
1760 struct sctp_transport
*peer
);
1761 void sctp_assoc_control_transport(struct sctp_association
*,
1762 struct sctp_transport
*,
1763 sctp_transport_cmd_t
, sctp_sn_error_t
);
1764 struct sctp_transport
*sctp_assoc_lookup_tsn(struct sctp_association
*, __u32
);
1765 struct sctp_transport
*sctp_assoc_is_match(struct sctp_association
*,
1766 const union sctp_addr
*,
1767 const union sctp_addr
*);
1768 void sctp_assoc_migrate(struct sctp_association
*, struct sock
*);
1769 void sctp_assoc_update(struct sctp_association
*old
,
1770 struct sctp_association
*new);
1772 __u32
sctp_association_get_next_tsn(struct sctp_association
*);
1774 void sctp_assoc_sync_pmtu(struct sctp_association
*);
1775 void sctp_assoc_rwnd_increase(struct sctp_association
*, unsigned);
1776 void sctp_assoc_rwnd_decrease(struct sctp_association
*, unsigned);
1777 void sctp_assoc_set_primary(struct sctp_association
*,
1778 struct sctp_transport
*);
1779 int sctp_assoc_set_bind_addr_from_ep(struct sctp_association
*,
1781 int sctp_assoc_set_bind_addr_from_cookie(struct sctp_association
*,
1782 struct sctp_cookie
*,
1785 int sctp_cmp_addr_exact(const union sctp_addr
*ss1
,
1786 const union sctp_addr
*ss2
);
1787 struct sctp_chunk
*sctp_get_ecne_prepend(struct sctp_association
*asoc
);
1789 /* A convenience structure to parse out SCTP specific CMSGs. */
1790 typedef struct sctp_cmsgs
{
1791 struct sctp_initmsg
*init
;
1792 struct sctp_sndrcvinfo
*info
;
1795 /* Structure for tracking memory objects */
1799 } sctp_dbg_objcnt_entry_t
;
1801 #endif /* __sctp_structs_h__ */