kvm tools, setup: Create private directory
[linux-2.6/next.git] / include / net / sctp / structs.h
blob7df327a6d564e8b2b57609ff714d4eb9a0e8b872
1 /* SCTP kernel implementation
2 * (C) Copyright IBM Corp. 2001, 2004
3 * Copyright (c) 1999-2000 Cisco, Inc.
4 * Copyright (c) 1999-2001 Motorola, Inc.
5 * Copyright (c) 2001 Intel Corp.
7 * This file is part of the SCTP kernel implementation
9 * This SCTP implementation is free software;
10 * you can redistribute it and/or modify it under the terms of
11 * the GNU General Public License as published by
12 * the Free Software Foundation; either version 2, or (at your option)
13 * any later version.
15 * This SCTP implementation is distributed in the hope that it
16 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
17 * ************************
18 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19 * See the GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with GNU CC; see the file COPYING. If not, write to
23 * the Free Software Foundation, 59 Temple Place - Suite 330,
24 * Boston, MA 02111-1307, USA.
26 * Please send any bug reports or fixes you make to the
27 * email addresses:
28 * lksctp developers <lksctp-developers@lists.sourceforge.net>
30 * Or submit a bug report through the following website:
31 * http://www.sf.net/projects/lksctp
33 * Written or modified by:
34 * Randall Stewart <randall@sctp.chicago.il.us>
35 * Ken Morneau <kmorneau@cisco.com>
36 * Qiaobing Xie <qxie1@email.mot.com>
37 * La Monte H.P. Yarroll <piggy@acm.org>
38 * Karl Knutson <karl@athena.chicago.il.us>
39 * Jon Grimm <jgrimm@us.ibm.com>
40 * Xingang Guo <xingang.guo@intel.com>
41 * Hui Huang <hui.huang@nokia.com>
42 * Sridhar Samudrala <sri@us.ibm.com>
43 * Daisy Chang <daisyc@us.ibm.com>
44 * Dajiang Zhang <dajiang.zhang@nokia.com>
45 * Ardelle Fan <ardelle.fan@intel.com>
46 * Ryan Layer <rmlayer@us.ibm.com>
47 * Anup Pemmaiah <pemmaiah@cc.usu.edu>
48 * Kevin Gao <kevin.gao@intel.com>
50 * Any bugs reported given to us we will try to fix... any fixes shared will
51 * be incorporated into the next SCTP release.
54 #ifndef __sctp_structs_h__
55 #define __sctp_structs_h__
57 #include <linux/time.h> /* We get struct timespec. */
58 #include <linux/socket.h> /* linux/in.h needs this!! */
59 #include <linux/in.h> /* We get struct sockaddr_in. */
60 #include <linux/in6.h> /* We get struct in6_addr */
61 #include <linux/ipv6.h>
62 #include <asm/param.h> /* We get MAXHOSTNAMELEN. */
63 #include <asm/atomic.h> /* This gets us atomic counters. */
64 #include <linux/skbuff.h> /* We need sk_buff_head. */
65 #include <linux/workqueue.h> /* We need tq_struct. */
66 #include <linux/sctp.h> /* We need sctp* header structs. */
67 #include <net/sctp/auth.h> /* We need auth specific structs */
69 /* A convenience structure for handling sockaddr structures.
70 * We should wean ourselves off this.
72 union sctp_addr {
73 struct sockaddr_in v4;
74 struct sockaddr_in6 v6;
75 struct sockaddr sa;
78 /* Forward declarations for data structures. */
79 struct sctp_globals;
80 struct sctp_endpoint;
81 struct sctp_association;
82 struct sctp_transport;
83 struct sctp_packet;
84 struct sctp_chunk;
85 struct sctp_inq;
86 struct sctp_outq;
87 struct sctp_bind_addr;
88 struct sctp_ulpq;
89 struct sctp_ep_common;
90 struct sctp_ssnmap;
91 struct crypto_hash;
94 #include <net/sctp/tsnmap.h>
95 #include <net/sctp/ulpevent.h>
96 #include <net/sctp/ulpqueue.h>
98 /* Structures useful for managing bind/connect. */
100 struct sctp_bind_bucket {
101 unsigned short port;
102 unsigned short fastreuse;
103 struct hlist_node node;
104 struct hlist_head owner;
107 struct sctp_bind_hashbucket {
108 spinlock_t lock;
109 struct hlist_head chain;
112 /* Used for hashing all associations. */
113 struct sctp_hashbucket {
114 rwlock_t lock;
115 struct hlist_head chain;
116 } __attribute__((__aligned__(8)));
119 /* The SCTP globals structure. */
120 extern struct sctp_globals {
121 /* RFC2960 Section 14. Suggested SCTP Protocol Parameter Values
123 * The following protocol parameters are RECOMMENDED:
125 * RTO.Initial - 3 seconds
126 * RTO.Min - 1 second
127 * RTO.Max - 60 seconds
128 * RTO.Alpha - 1/8 (3 when converted to right shifts.)
129 * RTO.Beta - 1/4 (2 when converted to right shifts.)
131 unsigned int rto_initial;
132 unsigned int rto_min;
133 unsigned int rto_max;
135 /* Note: rto_alpha and rto_beta are really defined as inverse
136 * powers of two to facilitate integer operations.
138 int rto_alpha;
139 int rto_beta;
141 /* Max.Burst - 4 */
142 int max_burst;
144 /* Whether Cookie Preservative is enabled(1) or not(0) */
145 int cookie_preserve_enable;
147 /* Valid.Cookie.Life - 60 seconds */
148 unsigned int valid_cookie_life;
150 /* Delayed SACK timeout 200ms default*/
151 unsigned int sack_timeout;
153 /* HB.interval - 30 seconds */
154 unsigned int hb_interval;
156 /* Association.Max.Retrans - 10 attempts
157 * Path.Max.Retrans - 5 attempts (per destination address)
158 * Max.Init.Retransmits - 8 attempts
160 int max_retrans_association;
161 int max_retrans_path;
162 int max_retrans_init;
165 * Policy for preforming sctp/socket accounting
166 * 0 - do socket level accounting, all assocs share sk_sndbuf
167 * 1 - do sctp accounting, each asoc may use sk_sndbuf bytes
169 int sndbuf_policy;
172 * Policy for preforming sctp/socket accounting
173 * 0 - do socket level accounting, all assocs share sk_rcvbuf
174 * 1 - do sctp accounting, each asoc may use sk_rcvbuf bytes
176 int rcvbuf_policy;
178 /* The following variables are implementation specific. */
180 /* Default initialization values to be applied to new associations. */
181 __u16 max_instreams;
182 __u16 max_outstreams;
184 /* This is a list of groups of functions for each address
185 * family that we support.
187 struct list_head address_families;
189 /* This is the hash of all endpoints. */
190 int ep_hashsize;
191 struct sctp_hashbucket *ep_hashtable;
193 /* This is the hash of all associations. */
194 int assoc_hashsize;
195 struct sctp_hashbucket *assoc_hashtable;
197 /* This is the sctp port control hash. */
198 int port_hashsize;
199 struct sctp_bind_hashbucket *port_hashtable;
201 /* This is the global local address list.
202 * We actively maintain this complete list of addresses on
203 * the system by catching address add/delete events.
205 * It is a list of sctp_sockaddr_entry.
207 struct list_head local_addr_list;
209 /* Lock that protects the local_addr_list writers */
210 spinlock_t addr_list_lock;
212 /* Flag to indicate if addip is enabled. */
213 int addip_enable;
214 int addip_noauth_enable;
216 /* Flag to indicate if PR-SCTP is enabled. */
217 int prsctp_enable;
219 /* Flag to idicate if SCTP-AUTH is enabled */
220 int auth_enable;
223 * Policy to control SCTP IPv4 address scoping
224 * 0 - Disable IPv4 address scoping
225 * 1 - Enable IPv4 address scoping
226 * 2 - Selectively allow only IPv4 private addresses
227 * 3 - Selectively allow only IPv4 link local address
229 int ipv4_scope_policy;
231 /* Flag to indicate whether computing and verifying checksum
232 * is disabled. */
233 int checksum_disable;
235 /* Threshold for rwnd update SACKS. Receive buffer shifted this many
236 * bits is an indicator of when to send and window update SACK.
238 int rwnd_update_shift;
239 } sctp_globals;
241 #define sctp_rto_initial (sctp_globals.rto_initial)
242 #define sctp_rto_min (sctp_globals.rto_min)
243 #define sctp_rto_max (sctp_globals.rto_max)
244 #define sctp_rto_alpha (sctp_globals.rto_alpha)
245 #define sctp_rto_beta (sctp_globals.rto_beta)
246 #define sctp_max_burst (sctp_globals.max_burst)
247 #define sctp_valid_cookie_life (sctp_globals.valid_cookie_life)
248 #define sctp_cookie_preserve_enable (sctp_globals.cookie_preserve_enable)
249 #define sctp_max_retrans_association (sctp_globals.max_retrans_association)
250 #define sctp_sndbuf_policy (sctp_globals.sndbuf_policy)
251 #define sctp_rcvbuf_policy (sctp_globals.rcvbuf_policy)
252 #define sctp_max_retrans_path (sctp_globals.max_retrans_path)
253 #define sctp_max_retrans_init (sctp_globals.max_retrans_init)
254 #define sctp_sack_timeout (sctp_globals.sack_timeout)
255 #define sctp_hb_interval (sctp_globals.hb_interval)
256 #define sctp_max_instreams (sctp_globals.max_instreams)
257 #define sctp_max_outstreams (sctp_globals.max_outstreams)
258 #define sctp_address_families (sctp_globals.address_families)
259 #define sctp_ep_hashsize (sctp_globals.ep_hashsize)
260 #define sctp_ep_hashtable (sctp_globals.ep_hashtable)
261 #define sctp_assoc_hashsize (sctp_globals.assoc_hashsize)
262 #define sctp_assoc_hashtable (sctp_globals.assoc_hashtable)
263 #define sctp_port_hashsize (sctp_globals.port_hashsize)
264 #define sctp_port_hashtable (sctp_globals.port_hashtable)
265 #define sctp_local_addr_list (sctp_globals.local_addr_list)
266 #define sctp_local_addr_lock (sctp_globals.addr_list_lock)
267 #define sctp_scope_policy (sctp_globals.ipv4_scope_policy)
268 #define sctp_addip_enable (sctp_globals.addip_enable)
269 #define sctp_addip_noauth (sctp_globals.addip_noauth_enable)
270 #define sctp_prsctp_enable (sctp_globals.prsctp_enable)
271 #define sctp_auth_enable (sctp_globals.auth_enable)
272 #define sctp_checksum_disable (sctp_globals.checksum_disable)
273 #define sctp_rwnd_upd_shift (sctp_globals.rwnd_update_shift)
275 /* SCTP Socket type: UDP or TCP style. */
276 typedef enum {
277 SCTP_SOCKET_UDP = 0,
278 SCTP_SOCKET_UDP_HIGH_BANDWIDTH,
279 SCTP_SOCKET_TCP
280 } sctp_socket_type_t;
282 /* Per socket SCTP information. */
283 struct sctp_sock {
284 /* inet_sock has to be the first member of sctp_sock */
285 struct inet_sock inet;
286 /* What kind of a socket is this? */
287 sctp_socket_type_t type;
289 /* PF_ family specific functions. */
290 struct sctp_pf *pf;
292 /* Access to HMAC transform. */
293 struct crypto_hash *hmac;
295 /* What is our base endpointer? */
296 struct sctp_endpoint *ep;
298 struct sctp_bind_bucket *bind_hash;
299 /* Various Socket Options. */
300 __u16 default_stream;
301 __u32 default_ppid;
302 __u16 default_flags;
303 __u32 default_context;
304 __u32 default_timetolive;
305 __u32 default_rcv_context;
306 int max_burst;
308 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
309 * the destination address every heartbeat interval. This value
310 * will be inherited by all new associations.
312 __u32 hbinterval;
314 /* This is the max_retrans value for new associations. */
315 __u16 pathmaxrxt;
317 /* The initial Path MTU to use for new associations. */
318 __u32 pathmtu;
320 /* The default SACK delay timeout for new associations. */
321 __u32 sackdelay;
322 __u32 sackfreq;
324 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
325 __u32 param_flags;
327 struct sctp_initmsg initmsg;
328 struct sctp_rtoinfo rtoinfo;
329 struct sctp_paddrparams paddrparam;
330 struct sctp_event_subscribe subscribe;
331 struct sctp_assocparams assocparams;
332 int user_frag;
333 __u32 autoclose;
334 __u8 nodelay;
335 __u8 disable_fragments;
336 __u8 v4mapped;
337 __u8 frag_interleave;
338 __u32 adaptation_ind;
339 __u32 pd_point;
341 atomic_t pd_mode;
342 /* Receive to here while partial delivery is in effect. */
343 struct sk_buff_head pd_lobby;
346 static inline struct sctp_sock *sctp_sk(const struct sock *sk)
348 return (struct sctp_sock *)sk;
351 static inline struct sock *sctp_opt2sk(const struct sctp_sock *sp)
353 return (struct sock *)sp;
356 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
357 struct sctp6_sock {
358 struct sctp_sock sctp;
359 struct ipv6_pinfo inet6;
361 #endif /* CONFIG_IPV6 */
364 /* This is our APPLICATION-SPECIFIC state cookie.
365 * THIS IS NOT DICTATED BY THE SPECIFICATION.
367 /* These are the parts of an association which we send in the cookie.
368 * Most of these are straight out of:
369 * RFC2960 12.2 Parameters necessary per association (i.e. the TCB)
373 struct sctp_cookie {
375 /* My : Tag expected in every inbound packet and sent
376 * Verification: in the INIT or INIT ACK chunk.
377 * Tag :
379 __u32 my_vtag;
381 /* Peer's : Tag expected in every outbound packet except
382 * Verification: in the INIT chunk.
383 * Tag :
385 __u32 peer_vtag;
387 /* The rest of these are not from the spec, but really need to
388 * be in the cookie.
391 /* My Tie Tag : Assist in discovering a restarting association. */
392 __u32 my_ttag;
394 /* Peer's Tie Tag: Assist in discovering a restarting association. */
395 __u32 peer_ttag;
397 /* When does this cookie expire? */
398 struct timeval expiration;
400 /* Number of inbound/outbound streams which are set
401 * and negotiated during the INIT process.
403 __u16 sinit_num_ostreams;
404 __u16 sinit_max_instreams;
406 /* This is the first sequence number I used. */
407 __u32 initial_tsn;
409 /* This holds the originating address of the INIT packet. */
410 union sctp_addr peer_addr;
412 /* IG Section 2.35.3
413 * Include the source port of the INIT-ACK
415 __u16 my_port;
417 __u8 prsctp_capable;
419 /* Padding for future use */
420 __u8 padding;
422 __u32 adaptation_ind;
424 __u8 auth_random[sizeof(sctp_paramhdr_t) + SCTP_AUTH_RANDOM_LENGTH];
425 __u8 auth_hmacs[SCTP_AUTH_NUM_HMACS * sizeof(__u16) + 2];
426 __u8 auth_chunks[sizeof(sctp_paramhdr_t) + SCTP_AUTH_MAX_CHUNKS];
428 /* This is a shim for my peer's INIT packet, followed by
429 * a copy of the raw address list of the association.
430 * The length of the raw address list is saved in the
431 * raw_addr_list_len field, which will be used at the time when
432 * the association TCB is re-constructed from the cookie.
434 __u32 raw_addr_list_len;
435 struct sctp_init_chunk peer_init[0];
439 /* The format of our cookie that we send to our peer. */
440 struct sctp_signed_cookie {
441 __u8 signature[SCTP_SECRET_SIZE];
442 __u32 __pad; /* force sctp_cookie alignment to 64 bits */
443 struct sctp_cookie c;
444 } __packed;
446 /* This is another convenience type to allocate memory for address
447 * params for the maximum size and pass such structures around
448 * internally.
450 union sctp_addr_param {
451 struct sctp_paramhdr p;
452 struct sctp_ipv4addr_param v4;
453 struct sctp_ipv6addr_param v6;
456 /* A convenience type to allow walking through the various
457 * parameters and avoid casting all over the place.
459 union sctp_params {
460 void *v;
461 struct sctp_paramhdr *p;
462 struct sctp_cookie_preserve_param *life;
463 struct sctp_hostname_param *dns;
464 struct sctp_cookie_param *cookie;
465 struct sctp_supported_addrs_param *sat;
466 struct sctp_ipv4addr_param *v4;
467 struct sctp_ipv6addr_param *v6;
468 union sctp_addr_param *addr;
469 struct sctp_adaptation_ind_param *aind;
470 struct sctp_supported_ext_param *ext;
471 struct sctp_random_param *random;
472 struct sctp_chunks_param *chunks;
473 struct sctp_hmac_algo_param *hmac_algo;
474 struct sctp_addip_param *addip;
477 /* RFC 2960. Section 3.3.5 Heartbeat.
478 * Heartbeat Information: variable length
479 * The Sender-specific Heartbeat Info field should normally include
480 * information about the sender's current time when this HEARTBEAT
481 * chunk is sent and the destination transport address to which this
482 * HEARTBEAT is sent (see Section 8.3).
484 typedef struct sctp_sender_hb_info {
485 struct sctp_paramhdr param_hdr;
486 union sctp_addr daddr;
487 unsigned long sent_at;
488 __u64 hb_nonce;
489 } __packed sctp_sender_hb_info_t;
492 * RFC 2960 1.3.2 Sequenced Delivery within Streams
494 * The term "stream" is used in SCTP to refer to a sequence of user
495 * messages that are to be delivered to the upper-layer protocol in
496 * order with respect to other messages within the same stream. This is
497 * in contrast to its usage in TCP, where it refers to a sequence of
498 * bytes (in this document a byte is assumed to be eight bits).
499 * ...
501 * This is the structure we use to track both our outbound and inbound
502 * SSN, or Stream Sequence Numbers.
505 struct sctp_stream {
506 __u16 *ssn;
507 unsigned int len;
510 struct sctp_ssnmap {
511 struct sctp_stream in;
512 struct sctp_stream out;
513 int malloced;
516 struct sctp_ssnmap *sctp_ssnmap_new(__u16 in, __u16 out,
517 gfp_t gfp);
518 void sctp_ssnmap_free(struct sctp_ssnmap *map);
519 void sctp_ssnmap_clear(struct sctp_ssnmap *map);
521 /* What is the current SSN number for this stream? */
522 static inline __u16 sctp_ssn_peek(struct sctp_stream *stream, __u16 id)
524 return stream->ssn[id];
527 /* Return the next SSN number for this stream. */
528 static inline __u16 sctp_ssn_next(struct sctp_stream *stream, __u16 id)
530 return stream->ssn[id]++;
533 /* Skip over this ssn and all below. */
534 static inline void sctp_ssn_skip(struct sctp_stream *stream, __u16 id,
535 __u16 ssn)
537 stream->ssn[id] = ssn+1;
541 * Pointers to address related SCTP functions.
542 * (i.e. things that depend on the address family.)
544 struct sctp_af {
545 int (*sctp_xmit) (struct sk_buff *skb,
546 struct sctp_transport *);
547 int (*setsockopt) (struct sock *sk,
548 int level,
549 int optname,
550 char __user *optval,
551 unsigned int optlen);
552 int (*getsockopt) (struct sock *sk,
553 int level,
554 int optname,
555 char __user *optval,
556 int __user *optlen);
557 int (*compat_setsockopt) (struct sock *sk,
558 int level,
559 int optname,
560 char __user *optval,
561 unsigned int optlen);
562 int (*compat_getsockopt) (struct sock *sk,
563 int level,
564 int optname,
565 char __user *optval,
566 int __user *optlen);
567 void (*get_dst) (struct sctp_transport *t,
568 union sctp_addr *saddr,
569 struct flowi *fl,
570 struct sock *sk);
571 void (*get_saddr) (struct sctp_sock *sk,
572 struct sctp_transport *t,
573 struct flowi *fl);
574 void (*copy_addrlist) (struct list_head *,
575 struct net_device *);
576 int (*cmp_addr) (const union sctp_addr *addr1,
577 const union sctp_addr *addr2);
578 void (*addr_copy) (union sctp_addr *dst,
579 union sctp_addr *src);
580 void (*from_skb) (union sctp_addr *,
581 struct sk_buff *skb,
582 int saddr);
583 void (*from_sk) (union sctp_addr *,
584 struct sock *sk);
585 void (*to_sk_saddr) (union sctp_addr *,
586 struct sock *sk);
587 void (*to_sk_daddr) (union sctp_addr *,
588 struct sock *sk);
589 void (*from_addr_param) (union sctp_addr *,
590 union sctp_addr_param *,
591 __be16 port, int iif);
592 int (*to_addr_param) (const union sctp_addr *,
593 union sctp_addr_param *);
594 int (*addr_valid) (union sctp_addr *,
595 struct sctp_sock *,
596 const struct sk_buff *);
597 sctp_scope_t (*scope) (union sctp_addr *);
598 void (*inaddr_any) (union sctp_addr *, __be16);
599 int (*is_any) (const union sctp_addr *);
600 int (*available) (union sctp_addr *,
601 struct sctp_sock *);
602 int (*skb_iif) (const struct sk_buff *sk);
603 int (*is_ce) (const struct sk_buff *sk);
604 void (*seq_dump_addr)(struct seq_file *seq,
605 union sctp_addr *addr);
606 void (*ecn_capable)(struct sock *sk);
607 __u16 net_header_len;
608 int sockaddr_len;
609 sa_family_t sa_family;
610 struct list_head list;
613 struct sctp_af *sctp_get_af_specific(sa_family_t);
614 int sctp_register_af(struct sctp_af *);
616 /* Protocol family functions. */
617 struct sctp_pf {
618 void (*event_msgname)(struct sctp_ulpevent *, char *, int *);
619 void (*skb_msgname) (struct sk_buff *, char *, int *);
620 int (*af_supported) (sa_family_t, struct sctp_sock *);
621 int (*cmp_addr) (const union sctp_addr *,
622 const union sctp_addr *,
623 struct sctp_sock *);
624 int (*bind_verify) (struct sctp_sock *, union sctp_addr *);
625 int (*send_verify) (struct sctp_sock *, union sctp_addr *);
626 int (*supported_addrs)(const struct sctp_sock *, __be16 *);
627 struct sock *(*create_accept_sk) (struct sock *sk,
628 struct sctp_association *asoc);
629 void (*addr_v4map) (struct sctp_sock *, union sctp_addr *);
630 struct sctp_af *af;
634 /* Structure to track chunk fragments that have been acked, but peer
635 * fragments of the same message have not.
637 struct sctp_datamsg {
638 /* Chunks waiting to be submitted to lower layer. */
639 struct list_head chunks;
640 /* Reference counting. */
641 atomic_t refcnt;
642 /* When is this message no longer interesting to the peer? */
643 unsigned long expires_at;
644 /* Did the messenge fail to send? */
645 int send_error;
646 u8 send_failed:1,
647 can_abandon:1, /* can chunks from this message can be abandoned. */
648 can_delay; /* should this message be Nagle delayed */
651 struct sctp_datamsg *sctp_datamsg_from_user(struct sctp_association *,
652 struct sctp_sndrcvinfo *,
653 struct msghdr *, int len);
654 void sctp_datamsg_free(struct sctp_datamsg *);
655 void sctp_datamsg_put(struct sctp_datamsg *);
656 void sctp_chunk_fail(struct sctp_chunk *, int error);
657 int sctp_chunk_abandoned(struct sctp_chunk *);
659 /* RFC2960 1.4 Key Terms
661 * o Chunk: A unit of information within an SCTP packet, consisting of
662 * a chunk header and chunk-specific content.
664 * As a matter of convenience, we remember the SCTP common header for
665 * each chunk as well as a few other header pointers...
667 struct sctp_chunk {
668 struct list_head list;
670 atomic_t refcnt;
672 /* This is our link to the per-transport transmitted list. */
673 struct list_head transmitted_list;
675 /* This field is used by chunks that hold fragmented data.
676 * For the first fragment this is the list that holds the rest of
677 * fragments. For the remaining fragments, this is the link to the
678 * frag_list maintained in the first fragment.
680 struct list_head frag_list;
682 /* This points to the sk_buff containing the actual data. */
683 struct sk_buff *skb;
685 /* These are the SCTP headers by reverse order in a packet.
686 * Note that some of these may happen more than once. In that
687 * case, we point at the "current" one, whatever that means
688 * for that level of header.
691 /* We point this at the FIRST TLV parameter to chunk_hdr. */
692 union sctp_params param_hdr;
693 union {
694 __u8 *v;
695 struct sctp_datahdr *data_hdr;
696 struct sctp_inithdr *init_hdr;
697 struct sctp_sackhdr *sack_hdr;
698 struct sctp_heartbeathdr *hb_hdr;
699 struct sctp_sender_hb_info *hbs_hdr;
700 struct sctp_shutdownhdr *shutdown_hdr;
701 struct sctp_signed_cookie *cookie_hdr;
702 struct sctp_ecnehdr *ecne_hdr;
703 struct sctp_cwrhdr *ecn_cwr_hdr;
704 struct sctp_errhdr *err_hdr;
705 struct sctp_addiphdr *addip_hdr;
706 struct sctp_fwdtsn_hdr *fwdtsn_hdr;
707 struct sctp_authhdr *auth_hdr;
708 } subh;
710 __u8 *chunk_end;
712 struct sctp_chunkhdr *chunk_hdr;
713 struct sctphdr *sctp_hdr;
715 /* This needs to be recoverable for SCTP_SEND_FAILED events. */
716 struct sctp_sndrcvinfo sinfo;
718 /* Which association does this belong to? */
719 struct sctp_association *asoc;
721 /* What endpoint received this chunk? */
722 struct sctp_ep_common *rcvr;
724 /* We fill this in if we are calculating RTT. */
725 unsigned long sent_at;
727 /* What is the origin IP address for this chunk? */
728 union sctp_addr source;
729 /* Destination address for this chunk. */
730 union sctp_addr dest;
732 /* For outbound message, track all fragments for SEND_FAILED. */
733 struct sctp_datamsg *msg;
735 /* For an inbound chunk, this tells us where it came from.
736 * For an outbound chunk, it tells us where we'd like it to
737 * go. It is NULL if we have no preference.
739 struct sctp_transport *transport;
741 /* SCTP-AUTH: For the special case inbound processing of COOKIE-ECHO
742 * we need save a pointer to the AUTH chunk, since the SCTP-AUTH
743 * spec violates the principle premis that all chunks are processed
744 * in order.
746 struct sk_buff *auth_chunk;
748 #define SCTP_CAN_FRTX 0x0
749 #define SCTP_NEED_FRTX 0x1
750 #define SCTP_DONT_FRTX 0x2
751 __u16 rtt_in_progress:1, /* This chunk used for RTT calc? */
752 has_tsn:1, /* Does this chunk have a TSN yet? */
753 has_ssn:1, /* Does this chunk have a SSN yet? */
754 singleton:1, /* Only chunk in the packet? */
755 end_of_packet:1, /* Last chunk in the packet? */
756 ecn_ce_done:1, /* Have we processed the ECN CE bit? */
757 pdiscard:1, /* Discard the whole packet now? */
758 tsn_gap_acked:1, /* Is this chunk acked by a GAP ACK? */
759 data_accepted:1, /* At least 1 chunk accepted */
760 auth:1, /* IN: was auth'ed | OUT: needs auth */
761 has_asconf:1, /* IN: have seen an asconf before */
762 tsn_missing_report:2, /* Data chunk missing counter. */
763 fast_retransmit:2; /* Is this chunk fast retransmitted? */
766 void sctp_chunk_hold(struct sctp_chunk *);
767 void sctp_chunk_put(struct sctp_chunk *);
768 int sctp_user_addto_chunk(struct sctp_chunk *chunk, int off, int len,
769 struct iovec *data);
770 void sctp_chunk_free(struct sctp_chunk *);
771 void *sctp_addto_chunk(struct sctp_chunk *, int len, const void *data);
772 void *sctp_addto_chunk_fixed(struct sctp_chunk *, int len, const void *data);
773 struct sctp_chunk *sctp_chunkify(struct sk_buff *,
774 const struct sctp_association *,
775 struct sock *);
776 void sctp_init_addrs(struct sctp_chunk *, union sctp_addr *,
777 union sctp_addr *);
778 const union sctp_addr *sctp_source(const struct sctp_chunk *chunk);
780 enum {
781 SCTP_ADDR_NEW, /* new address added to assoc/ep */
782 SCTP_ADDR_SRC, /* address can be used as source */
783 SCTP_ADDR_DEL, /* address about to be deleted */
786 /* This is a structure for holding either an IPv6 or an IPv4 address. */
787 struct sctp_sockaddr_entry {
788 struct list_head list;
789 struct rcu_head rcu;
790 union sctp_addr a;
791 __u8 state;
792 __u8 valid;
795 typedef struct sctp_chunk *(sctp_packet_phandler_t)(struct sctp_association *);
797 /* This structure holds lists of chunks as we are assembling for
798 * transmission.
800 struct sctp_packet {
801 /* These are the SCTP header values (host order) for the packet. */
802 __u16 source_port;
803 __u16 destination_port;
804 __u32 vtag;
806 /* This contains the payload chunks. */
807 struct list_head chunk_list;
809 /* This is the overhead of the sctp and ip headers. */
810 size_t overhead;
811 /* This is the total size of all chunks INCLUDING padding. */
812 size_t size;
814 /* The packet is destined for this transport address.
815 * The function we finally use to pass down to the next lower
816 * layer lives in the transport structure.
818 struct sctp_transport *transport;
820 /* pointer to the auth chunk for this packet */
821 struct sctp_chunk *auth;
823 u8 has_cookie_echo:1, /* This packet contains a COOKIE-ECHO chunk. */
824 has_sack:1, /* This packet contains a SACK chunk. */
825 has_auth:1, /* This packet contains an AUTH chunk */
826 has_data:1, /* This packet contains at least 1 DATA chunk */
827 ipfragok:1, /* So let ip fragment this packet */
828 malloced:1; /* Is it malloced? */
831 struct sctp_packet *sctp_packet_init(struct sctp_packet *,
832 struct sctp_transport *,
833 __u16 sport, __u16 dport);
834 struct sctp_packet *sctp_packet_config(struct sctp_packet *, __u32 vtag, int);
835 sctp_xmit_t sctp_packet_transmit_chunk(struct sctp_packet *,
836 struct sctp_chunk *, int);
837 sctp_xmit_t sctp_packet_append_chunk(struct sctp_packet *,
838 struct sctp_chunk *);
839 int sctp_packet_transmit(struct sctp_packet *);
840 void sctp_packet_free(struct sctp_packet *);
842 static inline int sctp_packet_empty(struct sctp_packet *packet)
844 return packet->size == packet->overhead;
847 /* This represents a remote transport address.
848 * For local transport addresses, we just use union sctp_addr.
850 * RFC2960 Section 1.4 Key Terms
852 * o Transport address: A Transport Address is traditionally defined
853 * by Network Layer address, Transport Layer protocol and Transport
854 * Layer port number. In the case of SCTP running over IP, a
855 * transport address is defined by the combination of an IP address
856 * and an SCTP port number (where SCTP is the Transport protocol).
858 * RFC2960 Section 7.1 SCTP Differences from TCP Congestion control
860 * o The sender keeps a separate congestion control parameter set for
861 * each of the destination addresses it can send to (not each
862 * source-destination pair but for each destination). The parameters
863 * should decay if the address is not used for a long enough time
864 * period.
867 struct sctp_transport {
868 /* A list of transports. */
869 struct list_head transports;
871 /* Reference counting. */
872 atomic_t refcnt;
873 __u32 dead:1,
874 /* RTO-Pending : A flag used to track if one of the DATA
875 * chunks sent to this address is currently being
876 * used to compute a RTT. If this flag is 0,
877 * the next DATA chunk sent to this destination
878 * should be used to compute a RTT and this flag
879 * should be set. Every time the RTT
880 * calculation completes (i.e. the DATA chunk
881 * is SACK'd) clear this flag.
883 rto_pending:1,
886 * hb_sent : a flag that signals that we have a pending
887 * heartbeat.
889 hb_sent:1,
891 /* Is the Path MTU update pending on this tranport */
892 pmtu_pending:1,
894 /* Is this structure kfree()able? */
895 malloced:1;
897 struct flowi fl;
899 /* This is the peer's IP address and port. */
900 union sctp_addr ipaddr;
902 /* These are the functions we call to handle LLP stuff. */
903 struct sctp_af *af_specific;
905 /* Which association do we belong to? */
906 struct sctp_association *asoc;
908 /* RFC2960
910 * 12.3 Per Transport Address Data
912 * For each destination transport address in the peer's
913 * address list derived from the INIT or INIT ACK chunk, a
914 * number of data elements needs to be maintained including:
916 /* RTO : The current retransmission timeout value. */
917 unsigned long rto;
919 __u32 rtt; /* This is the most recent RTT. */
921 /* RTTVAR : The current RTT variation. */
922 __u32 rttvar;
924 /* SRTT : The current smoothed round trip time. */
925 __u32 srtt;
928 * These are the congestion stats.
930 /* cwnd : The current congestion window. */
931 __u32 cwnd; /* This is the actual cwnd. */
933 /* ssthresh : The current slow start threshold value. */
934 __u32 ssthresh;
936 /* partial : The tracking method for increase of cwnd when in
937 * bytes acked : congestion avoidance mode (see Section 6.2.2)
939 __u32 partial_bytes_acked;
941 /* Data that has been sent, but not acknowledged. */
942 __u32 flight_size;
944 __u32 burst_limited; /* Holds old cwnd when max.burst is applied */
946 /* Destination */
947 struct dst_entry *dst;
948 /* Source address. */
949 union sctp_addr saddr;
951 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
952 * the destination address every heartbeat interval.
954 unsigned long hbinterval;
956 /* SACK delay timeout */
957 unsigned long sackdelay;
958 __u32 sackfreq;
960 /* When was the last time (in jiffies) that we heard from this
961 * transport? We use this to pick new active and retran paths.
963 unsigned long last_time_heard;
965 /* Last time(in jiffies) when cwnd is reduced due to the congestion
966 * indication based on ECNE chunk.
968 unsigned long last_time_ecne_reduced;
970 /* This is the max_retrans value for the transport and will
971 * be initialized from the assocs value. This can be changed
972 * using SCTP_SET_PEER_ADDR_PARAMS socket option.
974 __u16 pathmaxrxt;
976 /* PMTU : The current known path MTU. */
977 __u32 pathmtu;
979 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
980 __u32 param_flags;
982 /* The number of times INIT has been sent on this transport. */
983 int init_sent_count;
985 /* state : The current state of this destination,
986 * : i.e. SCTP_ACTIVE, SCTP_INACTIVE, SCTP_UNKNOWN.
988 int state;
990 /* These are the error stats for this destination. */
992 /* Error count : The current error count for this destination. */
993 unsigned short error_count;
995 /* Per : A timer used by each destination.
996 * Destination :
997 * Timer :
999 * [Everywhere else in the text this is called T3-rtx. -ed]
1001 struct timer_list T3_rtx_timer;
1003 /* Heartbeat timer is per destination. */
1004 struct timer_list hb_timer;
1006 /* Timer to handle ICMP proto unreachable envets */
1007 struct timer_list proto_unreach_timer;
1009 /* Since we're using per-destination retransmission timers
1010 * (see above), we're also using per-destination "transmitted"
1011 * queues. This probably ought to be a private struct
1012 * accessible only within the outqueue, but it's not, yet.
1014 struct list_head transmitted;
1016 /* We build bundle-able packets for this transport here. */
1017 struct sctp_packet packet;
1019 /* This is the list of transports that have chunks to send. */
1020 struct list_head send_ready;
1022 /* State information saved for SFR_CACC algorithm. The key
1023 * idea in SFR_CACC is to maintain state at the sender on a
1024 * per-destination basis when a changeover happens.
1025 * char changeover_active;
1026 * char cycling_changeover;
1027 * __u32 next_tsn_at_change;
1028 * char cacc_saw_newack;
1030 struct {
1031 /* An unsigned integer, which stores the next TSN to be
1032 * used by the sender, at the moment of changeover.
1034 __u32 next_tsn_at_change;
1036 /* A flag which indicates the occurrence of a changeover */
1037 char changeover_active;
1039 /* A flag which indicates whether the change of primary is
1040 * the first switch to this destination address during an
1041 * active switch.
1043 char cycling_changeover;
1045 /* A temporary flag, which is used during the processing of
1046 * a SACK to estimate the causative TSN(s)'s group.
1048 char cacc_saw_newack;
1049 } cacc;
1051 /* 64-bit random number sent with heartbeat. */
1052 __u64 hb_nonce;
1055 struct sctp_transport *sctp_transport_new(const union sctp_addr *,
1056 gfp_t);
1057 void sctp_transport_set_owner(struct sctp_transport *,
1058 struct sctp_association *);
1059 void sctp_transport_route(struct sctp_transport *, union sctp_addr *,
1060 struct sctp_sock *);
1061 void sctp_transport_pmtu(struct sctp_transport *, struct sock *sk);
1062 void sctp_transport_free(struct sctp_transport *);
1063 void sctp_transport_reset_timers(struct sctp_transport *);
1064 void sctp_transport_hold(struct sctp_transport *);
1065 void sctp_transport_put(struct sctp_transport *);
1066 void sctp_transport_update_rto(struct sctp_transport *, __u32);
1067 void sctp_transport_raise_cwnd(struct sctp_transport *, __u32, __u32);
1068 void sctp_transport_lower_cwnd(struct sctp_transport *, sctp_lower_cwnd_t);
1069 void sctp_transport_burst_limited(struct sctp_transport *);
1070 void sctp_transport_burst_reset(struct sctp_transport *);
1071 unsigned long sctp_transport_timeout(struct sctp_transport *);
1072 void sctp_transport_reset(struct sctp_transport *);
1073 void sctp_transport_update_pmtu(struct sctp_transport *, u32);
1076 /* This is the structure we use to queue packets as they come into
1077 * SCTP. We write packets to it and read chunks from it.
1079 struct sctp_inq {
1080 /* This is actually a queue of sctp_chunk each
1081 * containing a partially decoded packet.
1083 struct list_head in_chunk_list;
1084 /* This is the packet which is currently off the in queue and is
1085 * being worked on through the inbound chunk processing.
1087 struct sctp_chunk *in_progress;
1089 /* This is the delayed task to finish delivering inbound
1090 * messages.
1092 struct work_struct immediate;
1094 int malloced; /* Is this structure kfree()able? */
1097 void sctp_inq_init(struct sctp_inq *);
1098 void sctp_inq_free(struct sctp_inq *);
1099 void sctp_inq_push(struct sctp_inq *, struct sctp_chunk *packet);
1100 struct sctp_chunk *sctp_inq_pop(struct sctp_inq *);
1101 struct sctp_chunkhdr *sctp_inq_peek(struct sctp_inq *);
1102 void sctp_inq_set_th_handler(struct sctp_inq *, work_func_t);
1104 /* This is the structure we use to hold outbound chunks. You push
1105 * chunks in and they automatically pop out the other end as bundled
1106 * packets (it calls (*output_handler)()).
1108 * This structure covers sections 6.3, 6.4, 6.7, 6.8, 6.10, 7., 8.1,
1109 * and 8.2 of the v13 draft.
1111 * It handles retransmissions. The connection to the timeout portion
1112 * of the state machine is through sctp_..._timeout() and timeout_handler.
1114 * If you feed it SACKs, it will eat them.
1116 * If you give it big chunks, it will fragment them.
1118 * It assigns TSN's to data chunks. This happens at the last possible
1119 * instant before transmission.
1121 * When free()'d, it empties itself out via output_handler().
1123 struct sctp_outq {
1124 struct sctp_association *asoc;
1126 /* Data pending that has never been transmitted. */
1127 struct list_head out_chunk_list;
1129 unsigned out_qlen; /* Total length of queued data chunks. */
1131 /* Error of send failed, may used in SCTP_SEND_FAILED event. */
1132 unsigned error;
1134 /* These are control chunks we want to send. */
1135 struct list_head control_chunk_list;
1137 /* These are chunks that have been sacked but are above the
1138 * CTSN, or cumulative tsn ack point.
1140 struct list_head sacked;
1142 /* Put chunks on this list to schedule them for
1143 * retransmission.
1145 struct list_head retransmit;
1147 /* Put chunks on this list to save them for FWD TSN processing as
1148 * they were abandoned.
1150 struct list_head abandoned;
1152 /* How many unackd bytes do we have in-flight? */
1153 __u32 outstanding_bytes;
1155 /* Are we doing fast-rtx on this queue */
1156 char fast_rtx;
1158 /* Corked? */
1159 char cork;
1161 /* Is this structure empty? */
1162 char empty;
1164 /* Are we kfree()able? */
1165 char malloced;
1168 void sctp_outq_init(struct sctp_association *, struct sctp_outq *);
1169 void sctp_outq_teardown(struct sctp_outq *);
1170 void sctp_outq_free(struct sctp_outq*);
1171 int sctp_outq_tail(struct sctp_outq *, struct sctp_chunk *chunk);
1172 int sctp_outq_sack(struct sctp_outq *, struct sctp_sackhdr *);
1173 int sctp_outq_is_empty(const struct sctp_outq *);
1174 void sctp_outq_restart(struct sctp_outq *);
1176 void sctp_retransmit(struct sctp_outq *, struct sctp_transport *,
1177 sctp_retransmit_reason_t);
1178 void sctp_retransmit_mark(struct sctp_outq *, struct sctp_transport *, __u8);
1179 int sctp_outq_uncork(struct sctp_outq *);
1180 /* Uncork and flush an outqueue. */
1181 static inline void sctp_outq_cork(struct sctp_outq *q)
1183 q->cork = 1;
1186 /* These bind address data fields common between endpoints and associations */
1187 struct sctp_bind_addr {
1189 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1191 * SCTP Port: The local SCTP port number the endpoint is
1192 * bound to.
1194 __u16 port;
1196 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1198 * Address List: The list of IP addresses that this instance
1199 * has bound. This information is passed to one's
1200 * peer(s) in INIT and INIT ACK chunks.
1202 struct list_head address_list;
1204 int malloced; /* Are we kfree()able? */
1207 void sctp_bind_addr_init(struct sctp_bind_addr *, __u16 port);
1208 void sctp_bind_addr_free(struct sctp_bind_addr *);
1209 int sctp_bind_addr_copy(struct sctp_bind_addr *dest,
1210 const struct sctp_bind_addr *src,
1211 sctp_scope_t scope, gfp_t gfp,
1212 int flags);
1213 int sctp_bind_addr_dup(struct sctp_bind_addr *dest,
1214 const struct sctp_bind_addr *src,
1215 gfp_t gfp);
1216 int sctp_add_bind_addr(struct sctp_bind_addr *, union sctp_addr *,
1217 __u8 addr_state, gfp_t gfp);
1218 int sctp_del_bind_addr(struct sctp_bind_addr *, union sctp_addr *);
1219 int sctp_bind_addr_match(struct sctp_bind_addr *, const union sctp_addr *,
1220 struct sctp_sock *);
1221 int sctp_bind_addr_conflict(struct sctp_bind_addr *, const union sctp_addr *,
1222 struct sctp_sock *, struct sctp_sock *);
1223 int sctp_bind_addr_state(const struct sctp_bind_addr *bp,
1224 const union sctp_addr *addr);
1225 union sctp_addr *sctp_find_unmatch_addr(struct sctp_bind_addr *bp,
1226 const union sctp_addr *addrs,
1227 int addrcnt,
1228 struct sctp_sock *opt);
1229 union sctp_params sctp_bind_addrs_to_raw(const struct sctp_bind_addr *bp,
1230 int *addrs_len,
1231 gfp_t gfp);
1232 int sctp_raw_to_bind_addrs(struct sctp_bind_addr *bp, __u8 *raw, int len,
1233 __u16 port, gfp_t gfp);
1235 sctp_scope_t sctp_scope(const union sctp_addr *);
1236 int sctp_in_scope(const union sctp_addr *addr, const sctp_scope_t scope);
1237 int sctp_is_any(struct sock *sk, const union sctp_addr *addr);
1238 int sctp_addr_is_valid(const union sctp_addr *addr);
1241 /* What type of endpoint? */
1242 typedef enum {
1243 SCTP_EP_TYPE_SOCKET,
1244 SCTP_EP_TYPE_ASSOCIATION,
1245 } sctp_endpoint_type_t;
1248 * A common base class to bridge the implmentation view of a
1249 * socket (usually listening) endpoint versus an association's
1250 * local endpoint.
1251 * This common structure is useful for several purposes:
1252 * 1) Common interface for lookup routines.
1253 * a) Subfunctions work for either endpoint or association
1254 * b) Single interface to lookup allows hiding the lookup lock rather
1255 * than acquiring it externally.
1256 * 2) Common interface for the inbound chunk handling/state machine.
1257 * 3) Common object handling routines for reference counting, etc.
1258 * 4) Disentangle association lookup from endpoint lookup, where we
1259 * do not have to find our endpoint to find our association.
1263 struct sctp_ep_common {
1264 /* Fields to help us manage our entries in the hash tables. */
1265 struct hlist_node node;
1266 int hashent;
1268 /* Runtime type information. What kind of endpoint is this? */
1269 sctp_endpoint_type_t type;
1271 /* Some fields to help us manage this object.
1272 * refcnt - Reference count access to this object.
1273 * dead - Do not attempt to use this object.
1274 * malloced - Do we need to kfree this object?
1276 atomic_t refcnt;
1277 char dead;
1278 char malloced;
1280 /* What socket does this endpoint belong to? */
1281 struct sock *sk;
1283 /* This is where we receive inbound chunks. */
1284 struct sctp_inq inqueue;
1286 /* This substructure includes the defining parameters of the
1287 * endpoint:
1288 * bind_addr.port is our shared port number.
1289 * bind_addr.address_list is our set of local IP addresses.
1291 struct sctp_bind_addr bind_addr;
1295 /* RFC Section 1.4 Key Terms
1297 * o SCTP endpoint: The logical sender/receiver of SCTP packets. On a
1298 * multi-homed host, an SCTP endpoint is represented to its peers as a
1299 * combination of a set of eligible destination transport addresses to
1300 * which SCTP packets can be sent and a set of eligible source
1301 * transport addresses from which SCTP packets can be received.
1302 * All transport addresses used by an SCTP endpoint must use the
1303 * same port number, but can use multiple IP addresses. A transport
1304 * address used by an SCTP endpoint must not be used by another
1305 * SCTP endpoint. In other words, a transport address is unique
1306 * to an SCTP endpoint.
1308 * From an implementation perspective, each socket has one of these.
1309 * A TCP-style socket will have exactly one association on one of
1310 * these. An UDP-style socket will have multiple associations hanging
1311 * off one of these.
1314 struct sctp_endpoint {
1315 /* Common substructure for endpoint and association. */
1316 struct sctp_ep_common base;
1318 /* Associations: A list of current associations and mappings
1319 * to the data consumers for each association. This
1320 * may be in the form of a hash table or other
1321 * implementation dependent structure. The data
1322 * consumers may be process identification
1323 * information such as file descriptors, named pipe
1324 * pointer, or table pointers dependent on how SCTP
1325 * is implemented.
1327 /* This is really a list of struct sctp_association entries. */
1328 struct list_head asocs;
1330 /* Secret Key: A secret key used by this endpoint to compute
1331 * the MAC. This SHOULD be a cryptographic quality
1332 * random number with a sufficient length.
1333 * Discussion in [RFC1750] can be helpful in
1334 * selection of the key.
1336 __u8 secret_key[SCTP_HOW_MANY_SECRETS][SCTP_SECRET_SIZE];
1337 int current_key;
1338 int last_key;
1339 int key_changed_at;
1341 /* digest: This is a digest of the sctp cookie. This field is
1342 * only used on the receive path when we try to validate
1343 * that the cookie has not been tampered with. We put
1344 * this here so we pre-allocate this once and can re-use
1345 * on every receive.
1347 __u8 *digest;
1349 /* sendbuf acct. policy. */
1350 __u32 sndbuf_policy;
1352 /* rcvbuf acct. policy. */
1353 __u32 rcvbuf_policy;
1355 /* SCTP AUTH: array of the HMACs that will be allocated
1356 * we need this per association so that we don't serialize
1358 struct crypto_hash **auth_hmacs;
1360 /* SCTP-AUTH: hmacs for the endpoint encoded into parameter */
1361 struct sctp_hmac_algo_param *auth_hmacs_list;
1363 /* SCTP-AUTH: chunks to authenticate encoded into parameter */
1364 struct sctp_chunks_param *auth_chunk_list;
1366 /* SCTP-AUTH: endpoint shared keys */
1367 struct list_head endpoint_shared_keys;
1368 __u16 active_key_id;
1371 /* Recover the outter endpoint structure. */
1372 static inline struct sctp_endpoint *sctp_ep(struct sctp_ep_common *base)
1374 struct sctp_endpoint *ep;
1376 ep = container_of(base, struct sctp_endpoint, base);
1377 return ep;
1380 /* These are function signatures for manipulating endpoints. */
1381 struct sctp_endpoint *sctp_endpoint_new(struct sock *, gfp_t);
1382 void sctp_endpoint_free(struct sctp_endpoint *);
1383 void sctp_endpoint_put(struct sctp_endpoint *);
1384 void sctp_endpoint_hold(struct sctp_endpoint *);
1385 void sctp_endpoint_add_asoc(struct sctp_endpoint *, struct sctp_association *);
1386 struct sctp_association *sctp_endpoint_lookup_assoc(
1387 const struct sctp_endpoint *ep,
1388 const union sctp_addr *paddr,
1389 struct sctp_transport **);
1390 int sctp_endpoint_is_peeled_off(struct sctp_endpoint *,
1391 const union sctp_addr *);
1392 struct sctp_endpoint *sctp_endpoint_is_match(struct sctp_endpoint *,
1393 const union sctp_addr *);
1394 int sctp_has_association(const union sctp_addr *laddr,
1395 const union sctp_addr *paddr);
1397 int sctp_verify_init(const struct sctp_association *asoc, sctp_cid_t,
1398 sctp_init_chunk_t *peer_init, struct sctp_chunk *chunk,
1399 struct sctp_chunk **err_chunk);
1400 int sctp_process_init(struct sctp_association *, struct sctp_chunk *chunk,
1401 const union sctp_addr *peer,
1402 sctp_init_chunk_t *init, gfp_t gfp);
1403 __u32 sctp_generate_tag(const struct sctp_endpoint *);
1404 __u32 sctp_generate_tsn(const struct sctp_endpoint *);
1406 struct sctp_inithdr_host {
1407 __u32 init_tag;
1408 __u32 a_rwnd;
1409 __u16 num_outbound_streams;
1410 __u16 num_inbound_streams;
1411 __u32 initial_tsn;
1414 /* RFC2960
1416 * 12. Recommended Transmission Control Block (TCB) Parameters
1418 * This section details a recommended set of parameters that should
1419 * be contained within the TCB for an implementation. This section is
1420 * for illustrative purposes and should not be deemed as requirements
1421 * on an implementation or as an exhaustive list of all parameters
1422 * inside an SCTP TCB. Each implementation may need its own additional
1423 * parameters for optimization.
1427 /* Here we have information about each individual association. */
1428 struct sctp_association {
1430 /* A base structure common to endpoint and association.
1431 * In this context, it represents the associations's view
1432 * of the local endpoint of the association.
1434 struct sctp_ep_common base;
1436 /* Associations on the same socket. */
1437 struct list_head asocs;
1439 /* association id. */
1440 sctp_assoc_t assoc_id;
1442 /* This is our parent endpoint. */
1443 struct sctp_endpoint *ep;
1445 /* These are those association elements needed in the cookie. */
1446 struct sctp_cookie c;
1448 /* This is all information about our peer. */
1449 struct {
1450 /* rwnd
1452 * Peer Rwnd : Current calculated value of the peer's rwnd.
1454 __u32 rwnd;
1456 /* transport_addr_list
1458 * Peer : A list of SCTP transport addresses that the
1459 * Transport : peer is bound to. This information is derived
1460 * Address : from the INIT or INIT ACK and is used to
1461 * List : associate an inbound packet with a given
1462 * : association. Normally this information is
1463 * : hashed or keyed for quick lookup and access
1464 * : of the TCB.
1465 * : The list is also initialized with the list
1466 * : of addresses passed with the sctp_connectx()
1467 * : call.
1469 * It is a list of SCTP_transport's.
1471 struct list_head transport_addr_list;
1473 /* transport_count
1475 * Peer : A count of the number of peer addresses
1476 * Transport : in the Peer Transport Address List.
1477 * Address :
1478 * Count :
1480 __u16 transport_count;
1482 /* port
1483 * The transport layer port number.
1485 __u16 port;
1487 /* primary_path
1489 * Primary : This is the current primary destination
1490 * Path : transport address of the peer endpoint. It
1491 * : may also specify a source transport address
1492 * : on this endpoint.
1494 * All of these paths live on transport_addr_list.
1496 * At the bakeoffs, we discovered that the intent of
1497 * primaryPath is that it only changes when the ULP
1498 * asks to have it changed. We add the activePath to
1499 * designate the connection we are currently using to
1500 * transmit new data and most control chunks.
1502 struct sctp_transport *primary_path;
1504 /* Cache the primary path address here, when we
1505 * need a an address for msg_name.
1507 union sctp_addr primary_addr;
1509 /* active_path
1510 * The path that we are currently using to
1511 * transmit new data and most control chunks.
1513 struct sctp_transport *active_path;
1515 /* retran_path
1517 * RFC2960 6.4 Multi-homed SCTP Endpoints
1518 * ...
1519 * Furthermore, when its peer is multi-homed, an
1520 * endpoint SHOULD try to retransmit a chunk to an
1521 * active destination transport address that is
1522 * different from the last destination address to
1523 * which the DATA chunk was sent.
1525 struct sctp_transport *retran_path;
1527 /* Pointer to last transport I have sent on. */
1528 struct sctp_transport *last_sent_to;
1530 /* This is the last transport I have received DATA on. */
1531 struct sctp_transport *last_data_from;
1534 * Mapping An array of bits or bytes indicating which out of
1535 * Array order TSN's have been received (relative to the
1536 * Last Rcvd TSN). If no gaps exist, i.e. no out of
1537 * order packets have been received, this array
1538 * will be set to all zero. This structure may be
1539 * in the form of a circular buffer or bit array.
1541 * Last Rcvd : This is the last TSN received in
1542 * TSN : sequence. This value is set initially by
1543 * : taking the peer's Initial TSN, received in
1544 * : the INIT or INIT ACK chunk, and subtracting
1545 * : one from it.
1547 * Throughout most of the specification this is called the
1548 * "Cumulative TSN ACK Point". In this case, we
1549 * ignore the advice in 12.2 in favour of the term
1550 * used in the bulk of the text. This value is hidden
1551 * in tsn_map--we get it by calling sctp_tsnmap_get_ctsn().
1553 struct sctp_tsnmap tsn_map;
1555 /* Ack State : This flag indicates if the next received
1556 * : packet is to be responded to with a
1557 * : SACK. This is initializedto 0. When a packet
1558 * : is received it is incremented. If this value
1559 * : reaches 2 or more, a SACK is sent and the
1560 * : value is reset to 0. Note: This is used only
1561 * : when no DATA chunks are received out of
1562 * : order. When DATA chunks are out of order,
1563 * : SACK's are not delayed (see Section 6).
1565 __u8 sack_needed; /* Do we need to sack the peer? */
1566 __u32 sack_cnt;
1568 /* These are capabilities which our peer advertised. */
1569 __u8 ecn_capable:1, /* Can peer do ECN? */
1570 ipv4_address:1, /* Peer understands IPv4 addresses? */
1571 ipv6_address:1, /* Peer understands IPv6 addresses? */
1572 hostname_address:1, /* Peer understands DNS addresses? */
1573 asconf_capable:1, /* Does peer support ADDIP? */
1574 prsctp_capable:1, /* Can peer do PR-SCTP? */
1575 auth_capable:1; /* Is peer doing SCTP-AUTH? */
1577 __u32 adaptation_ind; /* Adaptation Code point. */
1579 /* This mask is used to disable sending the ASCONF chunk
1580 * with specified parameter to peer.
1582 __be16 addip_disabled_mask;
1584 struct sctp_inithdr_host i;
1585 int cookie_len;
1586 void *cookie;
1588 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
1589 * C1) ... "Peer-Serial-Number'. This value MUST be initialized to the
1590 * Initial TSN Value minus 1
1592 __u32 addip_serial;
1594 /* SCTP-AUTH: We need to know pears random number, hmac list
1595 * and authenticated chunk list. All that is part of the
1596 * cookie and these are just pointers to those locations
1598 sctp_random_param_t *peer_random;
1599 sctp_chunks_param_t *peer_chunks;
1600 sctp_hmac_algo_param_t *peer_hmacs;
1601 } peer;
1603 /* State : A state variable indicating what state the
1604 * : association is in, i.e. COOKIE-WAIT,
1605 * : COOKIE-ECHOED, ESTABLISHED, SHUTDOWN-PENDING,
1606 * : SHUTDOWN-SENT, SHUTDOWN-RECEIVED, SHUTDOWN-ACK-SENT.
1608 * Note: No "CLOSED" state is illustrated since if a
1609 * association is "CLOSED" its TCB SHOULD be removed.
1611 * In this implementation we DO have a CLOSED
1612 * state which is used during initiation and shutdown.
1614 * State takes values from SCTP_STATE_*.
1616 sctp_state_t state;
1618 /* The cookie life I award for any cookie. */
1619 struct timeval cookie_life;
1621 /* Overall : The overall association error count.
1622 * Error Count : [Clear this any time I get something.]
1624 int overall_error_count;
1626 /* These are the association's initial, max, and min RTO values.
1627 * These values will be initialized by system defaults, but can
1628 * be modified via the SCTP_RTOINFO socket option.
1630 unsigned long rto_initial;
1631 unsigned long rto_max;
1632 unsigned long rto_min;
1634 /* Maximum number of new data packets that can be sent in a burst. */
1635 int max_burst;
1637 /* This is the max_retrans value for the association. This value will
1638 * be initialized initialized from system defaults, but can be
1639 * modified by the SCTP_ASSOCINFO socket option.
1641 int max_retrans;
1643 /* Maximum number of times the endpoint will retransmit INIT */
1644 __u16 max_init_attempts;
1646 /* How many times have we resent an INIT? */
1647 __u16 init_retries;
1649 /* The largest timeout or RTO value to use in attempting an INIT */
1650 unsigned long max_init_timeo;
1652 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
1653 * the destination address every heartbeat interval. This value
1654 * will be inherited by all new transports.
1656 unsigned long hbinterval;
1658 /* This is the max_retrans value for new transports in the
1659 * association.
1661 __u16 pathmaxrxt;
1663 /* Flag that path mtu update is pending */
1664 __u8 pmtu_pending;
1666 /* Association : The smallest PMTU discovered for all of the
1667 * PMTU : peer's transport addresses.
1669 __u32 pathmtu;
1671 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
1672 __u32 param_flags;
1674 /* SACK delay timeout */
1675 unsigned long sackdelay;
1676 __u32 sackfreq;
1679 unsigned long timeouts[SCTP_NUM_TIMEOUT_TYPES];
1680 struct timer_list timers[SCTP_NUM_TIMEOUT_TYPES];
1682 /* Transport to which SHUTDOWN chunk was last sent. */
1683 struct sctp_transport *shutdown_last_sent_to;
1685 /* How many times have we resent a SHUTDOWN */
1686 int shutdown_retries;
1688 /* Transport to which INIT chunk was last sent. */
1689 struct sctp_transport *init_last_sent_to;
1691 /* Next TSN : The next TSN number to be assigned to a new
1692 * : DATA chunk. This is sent in the INIT or INIT
1693 * : ACK chunk to the peer and incremented each
1694 * : time a DATA chunk is assigned a TSN
1695 * : (normally just prior to transmit or during
1696 * : fragmentation).
1698 __u32 next_tsn;
1701 * Last Rcvd : This is the last TSN received in sequence. This value
1702 * TSN : is set initially by taking the peer's Initial TSN,
1703 * : received in the INIT or INIT ACK chunk, and
1704 * : subtracting one from it.
1706 * Most of RFC 2960 refers to this as the Cumulative TSN Ack Point.
1709 __u32 ctsn_ack_point;
1711 /* PR-SCTP Advanced.Peer.Ack.Point */
1712 __u32 adv_peer_ack_point;
1714 /* Highest TSN that is acknowledged by incoming SACKs. */
1715 __u32 highest_sacked;
1717 /* TSN marking the fast recovery exit point */
1718 __u32 fast_recovery_exit;
1720 /* Flag to track the current fast recovery state */
1721 __u8 fast_recovery;
1723 /* The number of unacknowledged data chunks. Reported through
1724 * the SCTP_STATUS sockopt.
1726 __u16 unack_data;
1728 /* The total number of data chunks that we've had to retransmit
1729 * as the result of a T3 timer expiration
1731 __u32 rtx_data_chunks;
1733 /* This is the association's receive buffer space. This value is used
1734 * to set a_rwnd field in an INIT or a SACK chunk.
1736 __u32 rwnd;
1738 /* This is the last advertised value of rwnd over a SACK chunk. */
1739 __u32 a_rwnd;
1741 /* Number of bytes by which the rwnd has slopped. The rwnd is allowed
1742 * to slop over a maximum of the association's frag_point.
1744 __u32 rwnd_over;
1746 /* Keeps treack of rwnd pressure. This happens when we have
1747 * a window, but not recevie buffer (i.e small packets). This one
1748 * is releases slowly (1 PMTU at a time ).
1750 __u32 rwnd_press;
1752 /* This is the sndbuf size in use for the association.
1753 * This corresponds to the sndbuf size for the association,
1754 * as specified in the sk->sndbuf.
1756 int sndbuf_used;
1758 /* This is the amount of memory that this association has allocated
1759 * in the receive path at any given time.
1761 atomic_t rmem_alloc;
1763 /* This is the wait queue head for send requests waiting on
1764 * the association sndbuf space.
1766 wait_queue_head_t wait;
1768 /* The message size at which SCTP fragmentation will occur. */
1769 __u32 frag_point;
1770 __u32 user_frag;
1772 /* Counter used to count INIT errors. */
1773 int init_err_counter;
1775 /* Count the number of INIT cycles (for doubling timeout). */
1776 int init_cycle;
1778 /* Default send parameters. */
1779 __u16 default_stream;
1780 __u16 default_flags;
1781 __u32 default_ppid;
1782 __u32 default_context;
1783 __u32 default_timetolive;
1785 /* Default receive parameters */
1786 __u32 default_rcv_context;
1788 /* This tracks outbound ssn for a given stream. */
1789 struct sctp_ssnmap *ssnmap;
1791 /* All outbound chunks go through this structure. */
1792 struct sctp_outq outqueue;
1794 /* A smart pipe that will handle reordering and fragmentation,
1795 * as well as handle passing events up to the ULP.
1797 struct sctp_ulpq ulpq;
1799 /* Last TSN that caused an ECNE Chunk to be sent. */
1800 __u32 last_ecne_tsn;
1802 /* Last TSN that caused a CWR Chunk to be sent. */
1803 __u32 last_cwr_tsn;
1805 /* How many duplicated TSNs have we seen? */
1806 int numduptsns;
1808 /* Number of seconds of idle time before an association is closed.
1809 * In the association context, this is really used as a boolean
1810 * since the real timeout is stored in the timeouts array
1812 __u32 autoclose;
1814 /* These are to support
1815 * "SCTP Extensions for Dynamic Reconfiguration of IP Addresses
1816 * and Enforcement of Flow and Message Limits"
1817 * <draft-ietf-tsvwg-addip-sctp-02.txt>
1818 * or "ADDIP" for short.
1823 /* ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1825 * R1) One and only one ASCONF Chunk MAY be in transit and
1826 * unacknowledged at any one time. If a sender, after sending
1827 * an ASCONF chunk, decides it needs to transfer another
1828 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1829 * returns from the previous ASCONF Chunk before sending a
1830 * subsequent ASCONF. Note this restriction binds each side,
1831 * so at any time two ASCONF may be in-transit on any given
1832 * association (one sent from each endpoint).
1834 * [This is our one-and-only-one ASCONF in flight. If we do
1835 * not have an ASCONF in flight, this is NULL.]
1837 struct sctp_chunk *addip_last_asconf;
1839 /* ADDIP Section 5.2 Upon reception of an ASCONF Chunk.
1841 * This is needed to implement itmes E1 - E4 of the updated
1842 * spec. Here is the justification:
1844 * Since the peer may bundle multiple ASCONF chunks toward us,
1845 * we now need the ability to cache multiple ACKs. The section
1846 * describes in detail how they are cached and cleaned up.
1848 struct list_head asconf_ack_list;
1850 /* These ASCONF chunks are waiting to be sent.
1852 * These chunaks can't be pushed to outqueue until receiving
1853 * ASCONF_ACK for the previous ASCONF indicated by
1854 * addip_last_asconf, so as to guarantee that only one ASCONF
1855 * is in flight at any time.
1857 * ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1859 * In defining the ASCONF Chunk transfer procedures, it is
1860 * essential that these transfers MUST NOT cause congestion
1861 * within the network. To achieve this, we place these
1862 * restrictions on the transfer of ASCONF Chunks:
1864 * R1) One and only one ASCONF Chunk MAY be in transit and
1865 * unacknowledged at any one time. If a sender, after sending
1866 * an ASCONF chunk, decides it needs to transfer another
1867 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1868 * returns from the previous ASCONF Chunk before sending a
1869 * subsequent ASCONF. Note this restriction binds each side,
1870 * so at any time two ASCONF may be in-transit on any given
1871 * association (one sent from each endpoint).
1874 * [I really think this is EXACTLY the sort of intelligence
1875 * which already resides in sctp_outq. Please move this
1876 * queue and its supporting logic down there. --piggy]
1878 struct list_head addip_chunk_list;
1880 /* ADDIP Section 4.1 ASCONF Chunk Procedures
1882 * A2) A serial number should be assigned to the Chunk. The
1883 * serial number SHOULD be a monotonically increasing
1884 * number. The serial number SHOULD be initialized at
1885 * the start of the association to the same value as the
1886 * Initial TSN and every time a new ASCONF chunk is created
1887 * it is incremented by one after assigning the serial number
1888 * to the newly created chunk.
1890 * ADDIP
1891 * 3.1.1 Address/Stream Configuration Change Chunk (ASCONF)
1893 * Serial Number : 32 bits (unsigned integer)
1895 * This value represents a Serial Number for the ASCONF
1896 * Chunk. The valid range of Serial Number is from 0 to
1897 * 4294967295 (2^32 - 1). Serial Numbers wrap back to 0
1898 * after reaching 4294967295.
1900 __u32 addip_serial;
1902 /* SCTP AUTH: list of the endpoint shared keys. These
1903 * keys are provided out of band by the user applicaton
1904 * and can't change during the lifetime of the association
1906 struct list_head endpoint_shared_keys;
1908 /* SCTP AUTH:
1909 * The current generated assocaition shared key (secret)
1911 struct sctp_auth_bytes *asoc_shared_key;
1913 /* SCTP AUTH: hmac id of the first peer requested algorithm
1914 * that we support.
1916 __u16 default_hmac_id;
1918 __u16 active_key_id;
1920 __u8 need_ecne:1, /* Need to send an ECNE Chunk? */
1921 temp:1; /* Is it a temporary association? */
1925 /* An eyecatcher for determining if we are really looking at an
1926 * association data structure.
1928 enum {
1929 SCTP_ASSOC_EYECATCHER = 0xa550c123,
1932 /* Recover the outter association structure. */
1933 static inline struct sctp_association *sctp_assoc(struct sctp_ep_common *base)
1935 struct sctp_association *asoc;
1937 asoc = container_of(base, struct sctp_association, base);
1938 return asoc;
1941 /* These are function signatures for manipulating associations. */
1944 struct sctp_association *
1945 sctp_association_new(const struct sctp_endpoint *, const struct sock *,
1946 sctp_scope_t scope, gfp_t gfp);
1947 void sctp_association_free(struct sctp_association *);
1948 void sctp_association_put(struct sctp_association *);
1949 void sctp_association_hold(struct sctp_association *);
1951 struct sctp_transport *sctp_assoc_choose_alter_transport(
1952 struct sctp_association *, struct sctp_transport *);
1953 void sctp_assoc_update_retran_path(struct sctp_association *);
1954 struct sctp_transport *sctp_assoc_lookup_paddr(const struct sctp_association *,
1955 const union sctp_addr *);
1956 int sctp_assoc_lookup_laddr(struct sctp_association *asoc,
1957 const union sctp_addr *laddr);
1958 struct sctp_transport *sctp_assoc_add_peer(struct sctp_association *,
1959 const union sctp_addr *address,
1960 const gfp_t gfp,
1961 const int peer_state);
1962 void sctp_assoc_del_peer(struct sctp_association *asoc,
1963 const union sctp_addr *addr);
1964 void sctp_assoc_rm_peer(struct sctp_association *asoc,
1965 struct sctp_transport *peer);
1966 void sctp_assoc_control_transport(struct sctp_association *,
1967 struct sctp_transport *,
1968 sctp_transport_cmd_t, sctp_sn_error_t);
1969 struct sctp_transport *sctp_assoc_lookup_tsn(struct sctp_association *, __u32);
1970 struct sctp_transport *sctp_assoc_is_match(struct sctp_association *,
1971 const union sctp_addr *,
1972 const union sctp_addr *);
1973 void sctp_assoc_migrate(struct sctp_association *, struct sock *);
1974 void sctp_assoc_update(struct sctp_association *old,
1975 struct sctp_association *new);
1977 __u32 sctp_association_get_next_tsn(struct sctp_association *);
1979 void sctp_assoc_sync_pmtu(struct sctp_association *);
1980 void sctp_assoc_rwnd_increase(struct sctp_association *, unsigned);
1981 void sctp_assoc_rwnd_decrease(struct sctp_association *, unsigned);
1982 void sctp_assoc_set_primary(struct sctp_association *,
1983 struct sctp_transport *);
1984 void sctp_assoc_del_nonprimary_peers(struct sctp_association *,
1985 struct sctp_transport *);
1986 int sctp_assoc_set_bind_addr_from_ep(struct sctp_association *,
1987 sctp_scope_t, gfp_t);
1988 int sctp_assoc_set_bind_addr_from_cookie(struct sctp_association *,
1989 struct sctp_cookie*,
1990 gfp_t gfp);
1991 int sctp_assoc_set_id(struct sctp_association *, gfp_t);
1992 void sctp_assoc_clean_asconf_ack_cache(const struct sctp_association *asoc);
1993 struct sctp_chunk *sctp_assoc_lookup_asconf_ack(
1994 const struct sctp_association *asoc,
1995 __be32 serial);
1996 void sctp_asconf_queue_teardown(struct sctp_association *asoc);
1998 int sctp_cmp_addr_exact(const union sctp_addr *ss1,
1999 const union sctp_addr *ss2);
2000 struct sctp_chunk *sctp_get_ecne_prepend(struct sctp_association *asoc);
2002 /* A convenience structure to parse out SCTP specific CMSGs. */
2003 typedef struct sctp_cmsgs {
2004 struct sctp_initmsg *init;
2005 struct sctp_sndrcvinfo *info;
2006 } sctp_cmsgs_t;
2008 /* Structure for tracking memory objects */
2009 typedef struct {
2010 char *label;
2011 atomic_t *counter;
2012 } sctp_dbg_objcnt_entry_t;
2014 #endif /* __sctp_structs_h__ */