fa87873fee76612bad4a765c7512503943f6bb0d
[linux-3.10.git] / include / net / sctp / structs.h
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.
6  *
7  * This file is part of the SCTP kernel reference Implementation
8  *
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)
13  * any later version.
14  *
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.
20  *
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.
25  *
26  * Please send any bug reports or fixes you make to the
27  * email addresses:
28  *    lksctp developers <lksctp-developers@lists.sourceforge.net>
29  *
30  * Or submit a bug report through the following website:
31  *    http://www.sf.net/projects/lksctp
32  *
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>
49  *
50  * Any bugs reported given to us we will try to fix... any fixes shared will
51  * be incorporated into the next SCTP release.
52  */
53
54 #ifndef __sctp_structs_h__
55 #define __sctp_structs_h__
56
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 */
68
69 /* A convenience structure for handling sockaddr structures.
70  * We should wean ourselves off this.
71  */
72 union sctp_addr {
73         struct sockaddr_in v4;
74         struct sockaddr_in6 v6;
75         struct sockaddr sa;
76 };
77
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;
92
93
94 #include <net/sctp/tsnmap.h>
95 #include <net/sctp/ulpevent.h>
96 #include <net/sctp/ulpqueue.h>
97
98 /* Structures useful for managing bind/connect. */
99
100 struct sctp_bind_bucket {
101         unsigned short  port;
102         unsigned short  fastreuse;
103         struct hlist_node       node;
104         struct hlist_head       owner;
105 };
106
107 struct sctp_bind_hashbucket {
108         spinlock_t      lock;
109         struct hlist_head       chain;
110 };
111
112 /* Used for hashing all associations.  */
113 struct sctp_hashbucket {
114         rwlock_t        lock;
115         struct hlist_head       chain;
116 } __attribute__((__aligned__(8)));
117
118
119 /* The SCTP globals structure. */
120 extern struct sctp_globals {
121         /* RFC2960 Section 14. Suggested SCTP Protocol Parameter Values
122          *
123          * The following protocol parameters are RECOMMENDED:
124          *
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.)
130          */
131         unsigned int rto_initial;
132         unsigned int rto_min;
133         unsigned int rto_max;
134
135         /* Note: rto_alpha and rto_beta are really defined as inverse
136          * powers of two to facilitate integer operations.
137          */
138         int rto_alpha;
139         int rto_beta;
140
141         /* Max.Burst                - 4 */
142         int max_burst;
143
144         /* Whether Cookie Preservative is enabled(1) or not(0) */
145         int cookie_preserve_enable;
146
147         /* Valid.Cookie.Life        - 60  seconds  */
148         unsigned int valid_cookie_life;
149
150         /* Delayed SACK timeout  200ms default*/
151         unsigned int sack_timeout;
152
153         /* HB.interval              - 30 seconds  */
154         unsigned int hb_interval;
155
156         /* Association.Max.Retrans  - 10 attempts
157          * Path.Max.Retrans         - 5  attempts (per destination address)
158          * Max.Init.Retransmits     - 8  attempts
159          */
160         int max_retrans_association;
161         int max_retrans_path;
162         int max_retrans_init;
163
164         /*
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
168          */
169         int sndbuf_policy;
170
171         /*
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
175          */
176         int rcvbuf_policy;
177
178         /* The following variables are implementation specific.  */
179
180         /* Default initialization values to be applied to new associations. */
181         __u16 max_instreams;
182         __u16 max_outstreams;
183
184         /* This is a list of groups of functions for each address
185          * family that we support.
186          */
187         struct list_head address_families;
188
189         /* This is the hash of all endpoints. */
190         int ep_hashsize;
191         struct sctp_hashbucket *ep_hashtable;
192
193         /* This is the hash of all associations. */
194         int assoc_hashsize;
195         struct sctp_hashbucket *assoc_hashtable;
196
197         /* This is the sctp port control hash.  */
198         int port_hashsize;
199         struct sctp_bind_hashbucket *port_hashtable;
200
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.
204          *
205          * It is a list of sctp_sockaddr_entry.
206          */
207         struct list_head local_addr_list;
208
209         /* Lock that protects the local_addr_list writers */
210         spinlock_t addr_list_lock;
211         
212         /* Flag to indicate if addip is enabled. */
213         int addip_enable;
214         int addip_noauth_enable;
215
216         /* Flag to indicate if PR-SCTP is enabled. */
217         int prsctp_enable;
218
219         /* Flag to idicate if SCTP-AUTH is enabled */
220         int auth_enable;
221 } sctp_globals;
222
223 #define sctp_rto_initial                (sctp_globals.rto_initial)
224 #define sctp_rto_min                    (sctp_globals.rto_min)
225 #define sctp_rto_max                    (sctp_globals.rto_max)
226 #define sctp_rto_alpha                  (sctp_globals.rto_alpha)
227 #define sctp_rto_beta                   (sctp_globals.rto_beta)
228 #define sctp_max_burst                  (sctp_globals.max_burst)
229 #define sctp_valid_cookie_life          (sctp_globals.valid_cookie_life)
230 #define sctp_cookie_preserve_enable     (sctp_globals.cookie_preserve_enable)
231 #define sctp_max_retrans_association    (sctp_globals.max_retrans_association)
232 #define sctp_sndbuf_policy              (sctp_globals.sndbuf_policy)
233 #define sctp_rcvbuf_policy              (sctp_globals.rcvbuf_policy)
234 #define sctp_max_retrans_path           (sctp_globals.max_retrans_path)
235 #define sctp_max_retrans_init           (sctp_globals.max_retrans_init)
236 #define sctp_sack_timeout               (sctp_globals.sack_timeout)
237 #define sctp_hb_interval                (sctp_globals.hb_interval)
238 #define sctp_max_instreams              (sctp_globals.max_instreams)
239 #define sctp_max_outstreams             (sctp_globals.max_outstreams)
240 #define sctp_address_families           (sctp_globals.address_families)
241 #define sctp_ep_hashsize                (sctp_globals.ep_hashsize)
242 #define sctp_ep_hashtable               (sctp_globals.ep_hashtable)
243 #define sctp_assoc_hashsize             (sctp_globals.assoc_hashsize)
244 #define sctp_assoc_hashtable            (sctp_globals.assoc_hashtable)
245 #define sctp_port_hashsize              (sctp_globals.port_hashsize)
246 #define sctp_port_rover                 (sctp_globals.port_rover)
247 #define sctp_port_alloc_lock            (sctp_globals.port_alloc_lock)
248 #define sctp_port_hashtable             (sctp_globals.port_hashtable)
249 #define sctp_local_addr_list            (sctp_globals.local_addr_list)
250 #define sctp_local_addr_lock            (sctp_globals.addr_list_lock)
251 #define sctp_addip_enable               (sctp_globals.addip_enable)
252 #define sctp_addip_noauth               (sctp_globals.addip_noauth_enable)
253 #define sctp_prsctp_enable              (sctp_globals.prsctp_enable)
254 #define sctp_auth_enable                (sctp_globals.auth_enable)
255
256 /* SCTP Socket type: UDP or TCP style. */
257 typedef enum {
258         SCTP_SOCKET_UDP = 0,
259         SCTP_SOCKET_UDP_HIGH_BANDWIDTH,
260         SCTP_SOCKET_TCP
261 } sctp_socket_type_t;
262
263 /* Per socket SCTP information. */
264 struct sctp_sock {
265         /* inet_sock has to be the first member of sctp_sock */
266         struct inet_sock inet;
267         /* What kind of a socket is this? */
268         sctp_socket_type_t type;
269
270         /* PF_ family specific functions.  */
271         struct sctp_pf *pf;
272
273         /* Access to HMAC transform. */
274         struct crypto_hash *hmac;
275
276         /* What is our base endpointer? */
277         struct sctp_endpoint *ep;
278
279         struct sctp_bind_bucket *bind_hash;
280         /* Various Socket Options.  */
281         __u16 default_stream;
282         __u32 default_ppid;
283         __u16 default_flags;
284         __u32 default_context;
285         __u32 default_timetolive;
286         __u32 default_rcv_context;
287         int max_burst;
288
289         /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
290          * the destination address every heartbeat interval. This value
291          * will be inherited by all new associations.
292          */
293         __u32 hbinterval;
294
295         /* This is the max_retrans value for new associations. */
296         __u16 pathmaxrxt;
297
298         /* The initial Path MTU to use for new associations. */
299         __u32 pathmtu;
300
301         /* The default SACK delay timeout for new associations. */
302         __u32 sackdelay;
303
304         /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
305         __u32 param_flags;
306
307         struct sctp_initmsg initmsg;
308         struct sctp_rtoinfo rtoinfo;
309         struct sctp_paddrparams paddrparam;
310         struct sctp_event_subscribe subscribe;
311         struct sctp_assocparams assocparams;
312         int user_frag;
313         __u32 autoclose;
314         __u8 nodelay;
315         __u8 disable_fragments;
316         __u8 v4mapped;
317         __u8 frag_interleave;
318         __u32 adaptation_ind;
319         __u32 pd_point;
320
321         atomic_t pd_mode;
322         /* Receive to here while partial delivery is in effect. */
323         struct sk_buff_head pd_lobby;
324 };
325
326 static inline struct sctp_sock *sctp_sk(const struct sock *sk)
327 {
328        return (struct sctp_sock *)sk;
329 }
330
331 static inline struct sock *sctp_opt2sk(const struct sctp_sock *sp)
332 {
333        return (struct sock *)sp;
334 }
335
336 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
337 struct sctp6_sock {
338        struct sctp_sock  sctp;
339        struct ipv6_pinfo inet6;
340 };
341 #endif /* CONFIG_IPV6 */
342
343
344 /* This is our APPLICATION-SPECIFIC state cookie.
345  * THIS IS NOT DICTATED BY THE SPECIFICATION.
346  */
347 /* These are the parts of an association which we send in the cookie.
348  * Most of these are straight out of:
349  * RFC2960 12.2 Parameters necessary per association (i.e. the TCB)
350  *
351  */
352
353 struct sctp_cookie {
354
355         /* My          : Tag expected in every inbound packet and sent
356          * Verification: in the INIT or INIT ACK chunk.
357          * Tag         :
358          */
359         __u32 my_vtag;
360
361         /* Peer's      : Tag expected in every outbound packet except
362          * Verification: in the INIT chunk.
363          * Tag         :
364          */
365         __u32 peer_vtag;
366
367         /* The rest of these are not from the spec, but really need to
368          * be in the cookie.
369          */
370
371         /* My Tie Tag  : Assist in discovering a restarting association. */
372         __u32 my_ttag;
373
374         /* Peer's Tie Tag: Assist in discovering a restarting association. */
375         __u32 peer_ttag;
376
377         /* When does this cookie expire? */
378         struct timeval expiration;
379
380         /* Number of inbound/outbound streams which are set
381          * and negotiated during the INIT process.
382          */
383         __u16 sinit_num_ostreams;
384         __u16 sinit_max_instreams;
385
386         /* This is the first sequence number I used.  */
387         __u32 initial_tsn;
388
389         /* This holds the originating address of the INIT packet.  */
390         union sctp_addr peer_addr;
391
392         /* IG Section 2.35.3 
393          * Include the source port of the INIT-ACK
394          */
395         __u16           my_port;
396
397         __u8 prsctp_capable;
398
399         /* Padding for future use */
400         __u8 padding;           
401
402         __u32 adaptation_ind;
403
404         __u8 auth_random[sizeof(sctp_paramhdr_t) + SCTP_AUTH_RANDOM_LENGTH];
405         __u8 auth_hmacs[SCTP_AUTH_NUM_HMACS + 2];
406         __u8 auth_chunks[sizeof(sctp_paramhdr_t) + SCTP_AUTH_MAX_CHUNKS];
407
408         /* This is a shim for my peer's INIT packet, followed by
409          * a copy of the raw address list of the association.
410          * The length of the raw address list is saved in the
411          * raw_addr_list_len field, which will be used at the time when
412          * the association TCB is re-constructed from the cookie.
413          */
414         __u32 raw_addr_list_len;
415         struct sctp_init_chunk peer_init[0];
416 };
417
418
419 /* The format of our cookie that we send to our peer. */
420 struct sctp_signed_cookie {
421         __u8 signature[SCTP_SECRET_SIZE];
422         __u32 __pad;            /* force sctp_cookie alignment to 64 bits */
423         struct sctp_cookie c;
424 } __attribute__((packed));
425
426 /* This is another convenience type to allocate memory for address
427  * params for the maximum size and pass such structures around
428  * internally.
429  */
430 union sctp_addr_param {
431         struct sctp_paramhdr p;
432         struct sctp_ipv4addr_param v4;
433         struct sctp_ipv6addr_param v6;
434 };
435
436 /* A convenience type to allow walking through the various
437  * parameters and avoid casting all over the place.
438  */
439 union sctp_params {
440         void *v;
441         struct sctp_paramhdr *p;
442         struct sctp_cookie_preserve_param *life;
443         struct sctp_hostname_param *dns;
444         struct sctp_cookie_param *cookie;
445         struct sctp_supported_addrs_param *sat;
446         struct sctp_ipv4addr_param *v4;
447         struct sctp_ipv6addr_param *v6;
448         union sctp_addr_param *addr;
449         struct sctp_adaptation_ind_param *aind;
450         struct sctp_supported_ext_param *ext;
451         struct sctp_random_param *random;
452         struct sctp_chunks_param *chunks;
453         struct sctp_hmac_algo_param *hmac_algo;
454         struct sctp_addip_param *addip;
455 };
456
457 /* RFC 2960.  Section 3.3.5 Heartbeat.
458  *    Heartbeat Information: variable length
459  *    The Sender-specific Heartbeat Info field should normally include
460  *    information about the sender's current time when this HEARTBEAT
461  *    chunk is sent and the destination transport address to which this
462  *    HEARTBEAT is sent (see Section 8.3).
463  */
464 typedef struct sctp_sender_hb_info {
465         struct sctp_paramhdr param_hdr;
466         union sctp_addr daddr;
467         unsigned long sent_at;
468         __u64 hb_nonce;
469 } __attribute__((packed)) sctp_sender_hb_info_t;
470
471 /*
472  *  RFC 2960 1.3.2 Sequenced Delivery within Streams
473  *
474  *  The term "stream" is used in SCTP to refer to a sequence of user
475  *  messages that are to be delivered to the upper-layer protocol in
476  *  order with respect to other messages within the same stream.  This is
477  *  in contrast to its usage in TCP, where it refers to a sequence of
478  *  bytes (in this document a byte is assumed to be eight bits).
479  *  ...
480  *
481  *  This is the structure we use to track both our outbound and inbound
482  *  SSN, or Stream Sequence Numbers.
483  */
484
485 struct sctp_stream {
486         __u16 *ssn;
487         unsigned int len;
488 };
489
490 struct sctp_ssnmap {
491         struct sctp_stream in;
492         struct sctp_stream out;
493         int malloced;
494 };
495
496 struct sctp_ssnmap *sctp_ssnmap_new(__u16 in, __u16 out,
497                                     gfp_t gfp);
498 void sctp_ssnmap_free(struct sctp_ssnmap *map);
499 void sctp_ssnmap_clear(struct sctp_ssnmap *map);
500
501 /* What is the current SSN number for this stream? */
502 static inline __u16 sctp_ssn_peek(struct sctp_stream *stream, __u16 id)
503 {
504         return stream->ssn[id];
505 }
506
507 /* Return the next SSN number for this stream.  */
508 static inline __u16 sctp_ssn_next(struct sctp_stream *stream, __u16 id)
509 {
510         return stream->ssn[id]++;
511 }
512
513 /* Skip over this ssn and all below. */
514 static inline void sctp_ssn_skip(struct sctp_stream *stream, __u16 id, 
515                                  __u16 ssn)
516 {
517         stream->ssn[id] = ssn+1;
518 }
519               
520 /*
521  * Pointers to address related SCTP functions.
522  * (i.e. things that depend on the address family.)
523  */
524 struct sctp_af {
525         int             (*sctp_xmit)    (struct sk_buff *skb,
526                                          struct sctp_transport *,
527                                          int ipfragok);
528         int             (*setsockopt)   (struct sock *sk,
529                                          int level,
530                                          int optname,
531                                          char __user *optval,
532                                          int optlen);
533         int             (*getsockopt)   (struct sock *sk,
534                                          int level,
535                                          int optname,
536                                          char __user *optval,
537                                          int __user *optlen);
538         int             (*compat_setsockopt)    (struct sock *sk,
539                                          int level,
540                                          int optname,
541                                          char __user *optval,
542                                          int optlen);
543         int             (*compat_getsockopt)    (struct sock *sk,
544                                          int level,
545                                          int optname,
546                                          char __user *optval,
547                                          int __user *optlen);
548         struct dst_entry *(*get_dst)    (struct sctp_association *asoc,
549                                          union sctp_addr *daddr,
550                                          union sctp_addr *saddr);
551         void            (*get_saddr)    (struct sctp_association *asoc,
552                                          struct dst_entry *dst,
553                                          union sctp_addr *daddr,
554                                          union sctp_addr *saddr);
555         void            (*copy_addrlist) (struct list_head *,
556                                           struct net_device *);
557         void            (*dst_saddr)    (union sctp_addr *saddr,
558                                          struct dst_entry *dst,
559                                          __be16 port);
560         int             (*cmp_addr)     (const union sctp_addr *addr1,
561                                          const union sctp_addr *addr2);
562         void            (*addr_copy)    (union sctp_addr *dst,
563                                          union sctp_addr *src);
564         void            (*from_skb)     (union sctp_addr *,
565                                          struct sk_buff *skb,
566                                          int saddr);
567         void            (*from_sk)      (union sctp_addr *,
568                                          struct sock *sk);
569         void            (*to_sk_saddr)  (union sctp_addr *,
570                                          struct sock *sk);
571         void            (*to_sk_daddr)  (union sctp_addr *,
572                                          struct sock *sk);
573         void            (*from_addr_param) (union sctp_addr *,
574                                             union sctp_addr_param *,
575                                             __be16 port, int iif);
576         int             (*to_addr_param) (const union sctp_addr *,
577                                           union sctp_addr_param *); 
578         int             (*addr_valid)   (union sctp_addr *,
579                                          struct sctp_sock *,
580                                          const struct sk_buff *);
581         sctp_scope_t    (*scope) (union sctp_addr *);
582         void            (*inaddr_any)   (union sctp_addr *, __be16);
583         int             (*is_any)       (const union sctp_addr *);
584         int             (*available)    (union sctp_addr *,
585                                          struct sctp_sock *);
586         int             (*skb_iif)      (const struct sk_buff *sk);
587         int             (*is_ce)        (const struct sk_buff *sk);
588         void            (*seq_dump_addr)(struct seq_file *seq,
589                                          union sctp_addr *addr);
590         __u16           net_header_len;
591         int             sockaddr_len;
592         sa_family_t     sa_family;
593         struct list_head list;
594 };
595
596 struct sctp_af *sctp_get_af_specific(sa_family_t);
597 int sctp_register_af(struct sctp_af *);
598
599 /* Protocol family functions. */
600 struct sctp_pf {
601         void (*event_msgname)(struct sctp_ulpevent *, char *, int *);
602         void (*skb_msgname)  (struct sk_buff *, char *, int *);
603         int  (*af_supported) (sa_family_t, struct sctp_sock *);
604         int  (*cmp_addr) (const union sctp_addr *,
605                           const union sctp_addr *,
606                           struct sctp_sock *);
607         int  (*bind_verify) (struct sctp_sock *, union sctp_addr *);
608         int  (*send_verify) (struct sctp_sock *, union sctp_addr *);
609         int  (*supported_addrs)(const struct sctp_sock *, __be16 *);
610         struct sock *(*create_accept_sk) (struct sock *sk,
611                                           struct sctp_association *asoc);
612         void (*addr_v4map) (struct sctp_sock *, union sctp_addr *);
613         struct sctp_af *af;
614 };
615
616
617 /* Structure to track chunk fragments that have been acked, but peer
618  * fragments of the same message have not.
619  */
620 struct sctp_datamsg {
621         /* Chunks waiting to be submitted to lower layer. */
622         struct list_head chunks;
623         /* Chunks that have been transmitted. */
624         struct list_head track;
625         /* Reference counting. */
626         atomic_t refcnt;
627         /* When is this message no longer interesting to the peer? */
628         unsigned long expires_at;
629         /* Did the messenge fail to send? */
630         int send_error;
631         char send_failed;
632         /* Control whether chunks from this message can be abandoned. */
633         char can_abandon;
634 };
635
636 struct sctp_datamsg *sctp_datamsg_from_user(struct sctp_association *,
637                                             struct sctp_sndrcvinfo *,
638                                             struct msghdr *, int len);
639 void sctp_datamsg_put(struct sctp_datamsg *);
640 void sctp_datamsg_free(struct sctp_datamsg *);
641 void sctp_datamsg_track(struct sctp_chunk *);
642 void sctp_chunk_fail(struct sctp_chunk *, int error);
643 int sctp_chunk_abandoned(struct sctp_chunk *);
644
645 /* RFC2960 1.4 Key Terms
646  *
647  * o Chunk: A unit of information within an SCTP packet, consisting of
648  * a chunk header and chunk-specific content.
649  *
650  * As a matter of convenience, we remember the SCTP common header for
651  * each chunk as well as a few other header pointers...
652  */
653 struct sctp_chunk {
654         struct list_head list;
655
656         atomic_t refcnt;
657
658         /* This is our link to the per-transport transmitted list.  */
659         struct list_head transmitted_list;
660
661         /* This field is used by chunks that hold fragmented data.
662          * For the first fragment this is the list that holds the rest of
663          * fragments. For the remaining fragments, this is the link to the
664          * frag_list maintained in the first fragment.
665          */
666         struct list_head frag_list;
667
668         /* This points to the sk_buff containing the actual data.  */
669         struct sk_buff *skb;
670
671         /* These are the SCTP headers by reverse order in a packet.
672          * Note that some of these may happen more than once.  In that
673          * case, we point at the "current" one, whatever that means
674          * for that level of header.
675          */
676
677         /* We point this at the FIRST TLV parameter to chunk_hdr.  */
678         union sctp_params param_hdr;
679         union {
680                 __u8 *v;
681                 struct sctp_datahdr *data_hdr;
682                 struct sctp_inithdr *init_hdr;
683                 struct sctp_sackhdr *sack_hdr;
684                 struct sctp_heartbeathdr *hb_hdr;
685                 struct sctp_sender_hb_info *hbs_hdr;
686                 struct sctp_shutdownhdr *shutdown_hdr;
687                 struct sctp_signed_cookie *cookie_hdr;
688                 struct sctp_ecnehdr *ecne_hdr;
689                 struct sctp_cwrhdr *ecn_cwr_hdr;
690                 struct sctp_errhdr *err_hdr;
691                 struct sctp_addiphdr *addip_hdr;
692                 struct sctp_fwdtsn_hdr *fwdtsn_hdr;
693                 struct sctp_authhdr *auth_hdr;
694         } subh;
695
696         __u8 *chunk_end;
697
698         struct sctp_chunkhdr *chunk_hdr;
699         struct sctphdr *sctp_hdr;
700
701         /* This needs to be recoverable for SCTP_SEND_FAILED events. */
702         struct sctp_sndrcvinfo sinfo;
703
704         /* Which association does this belong to?  */
705         struct sctp_association *asoc;
706
707         /* What endpoint received this chunk? */
708         struct sctp_ep_common *rcvr;
709
710         /* We fill this in if we are calculating RTT. */
711         unsigned long sent_at;
712
713         /* What is the origin IP address for this chunk?  */
714         union sctp_addr source;
715         /* Destination address for this chunk. */
716         union sctp_addr dest;
717
718         /* For outbound message, track all fragments for SEND_FAILED. */
719         struct sctp_datamsg *msg;
720
721         /* For an inbound chunk, this tells us where it came from.
722          * For an outbound chunk, it tells us where we'd like it to
723          * go.  It is NULL if we have no preference.
724          */
725         struct sctp_transport *transport;
726
727         /* SCTP-AUTH:  For the special case inbound processing of COOKIE-ECHO
728          * we need save a pointer to the AUTH chunk, since the SCTP-AUTH
729          * spec violates the principle premis that all chunks are processed
730          * in order.
731          */
732         struct sk_buff *auth_chunk;
733
734         __u8 rtt_in_progress;   /* Is this chunk used for RTT calculation? */
735         __u8 resent;            /* Has this chunk ever been retransmitted. */
736         __u8 has_tsn;           /* Does this chunk have a TSN yet? */
737         __u8 has_ssn;           /* Does this chunk have a SSN yet? */
738         __u8 singleton;         /* Was this the only chunk in the packet? */
739         __u8 end_of_packet;     /* Was this the last chunk in the packet? */
740         __u8 ecn_ce_done;       /* Have we processed the ECN CE bit? */
741         __u8 pdiscard;          /* Discard the whole packet now? */
742         __u8 tsn_gap_acked;     /* Is this chunk acked by a GAP ACK? */
743         __s8 fast_retransmit;    /* Is this chunk fast retransmitted? */
744         __u8 tsn_missing_report; /* Data chunk missing counter. */
745         __u8 data_accepted;     /* At least 1 chunk in this packet accepted */
746         __u8 auth;              /* IN: was auth'ed | OUT: needs auth */
747         __u8 has_asconf;        /* IN: have seen an asconf before */
748 };
749
750 void sctp_chunk_hold(struct sctp_chunk *);
751 void sctp_chunk_put(struct sctp_chunk *);
752 int sctp_user_addto_chunk(struct sctp_chunk *chunk, int off, int len,
753                           struct iovec *data);
754 void sctp_chunk_free(struct sctp_chunk *);
755 void  *sctp_addto_chunk(struct sctp_chunk *, int len, const void *data);
756 struct sctp_chunk *sctp_chunkify(struct sk_buff *,
757                                  const struct sctp_association *,
758                                  struct sock *);
759 void sctp_init_addrs(struct sctp_chunk *, union sctp_addr *,
760                      union sctp_addr *);
761 const union sctp_addr *sctp_source(const struct sctp_chunk *chunk);
762
763 /* This is a structure for holding either an IPv6 or an IPv4 address.  */
764 struct sctp_sockaddr_entry {
765         struct list_head list;
766         struct rcu_head rcu;
767         union sctp_addr a;
768         __u8 use_as_src;
769         __u8 valid;
770 };
771
772 typedef struct sctp_chunk *(sctp_packet_phandler_t)(struct sctp_association *);
773
774 /* This structure holds lists of chunks as we are assembling for
775  * transmission.
776  */
777 struct sctp_packet {
778         /* These are the SCTP header values (host order) for the packet. */
779         __u16 source_port;
780         __u16 destination_port;
781         __u32 vtag;
782
783         /* This contains the payload chunks.  */
784         struct list_head chunk_list;
785
786         /* This is the overhead of the sctp and ip headers. */
787         size_t overhead;
788         /* This is the total size of all chunks INCLUDING padding.  */
789         size_t size;
790
791         /* The packet is destined for this transport address.
792          * The function we finally use to pass down to the next lower
793          * layer lives in the transport structure.
794          */
795         struct sctp_transport *transport;
796
797         /* pointer to the auth chunk for this packet */
798         struct sctp_chunk *auth;
799
800         /* This packet contains a COOKIE-ECHO chunk. */
801         __u8 has_cookie_echo;
802
803         /* This packet contains a SACK chunk. */
804         __u8 has_sack;
805
806         /* This packet contains an AUTH chunk */
807         __u8 has_auth;
808
809         /* This packet contains at least 1 DATA chunk */
810         __u8 has_data;
811
812         /* SCTP cannot fragment this packet. So let ip fragment it. */
813         __u8 ipfragok;
814
815         __u8 malloced;
816 };
817
818 struct sctp_packet *sctp_packet_init(struct sctp_packet *,
819                                      struct sctp_transport *,
820                                      __u16 sport, __u16 dport);
821 struct sctp_packet *sctp_packet_config(struct sctp_packet *, __u32 vtag, int);
822 sctp_xmit_t sctp_packet_transmit_chunk(struct sctp_packet *,
823                                        struct sctp_chunk *);
824 sctp_xmit_t sctp_packet_append_chunk(struct sctp_packet *,
825                                      struct sctp_chunk *);
826 int sctp_packet_transmit(struct sctp_packet *);
827 void sctp_packet_free(struct sctp_packet *);
828
829 static inline int sctp_packet_empty(struct sctp_packet *packet)
830 {
831         return (packet->size == packet->overhead);
832 }
833
834 /* This represents a remote transport address.
835  * For local transport addresses, we just use union sctp_addr.
836  *
837  * RFC2960 Section 1.4 Key Terms
838  *
839  *   o  Transport address:  A Transport Address is traditionally defined
840  *      by Network Layer address, Transport Layer protocol and Transport
841  *      Layer port number.  In the case of SCTP running over IP, a
842  *      transport address is defined by the combination of an IP address
843  *      and an SCTP port number (where SCTP is the Transport protocol).
844  *
845  * RFC2960 Section 7.1 SCTP Differences from TCP Congestion control
846  *
847  *   o  The sender keeps a separate congestion control parameter set for
848  *      each of the destination addresses it can send to (not each
849  *      source-destination pair but for each destination).  The parameters
850  *      should decay if the address is not used for a long enough time
851  *      period.
852  *
853  */
854 struct sctp_transport {
855         /* A list of transports. */
856         struct list_head transports;
857
858         /* Reference counting. */
859         atomic_t refcnt;
860         int      dead;
861
862         /* This is the peer's IP address and port. */
863         union sctp_addr ipaddr;
864
865         /* These are the functions we call to handle LLP stuff.  */
866         struct sctp_af *af_specific;
867
868         /* Which association do we belong to?  */
869         struct sctp_association *asoc;
870
871         /* RFC2960
872          *
873          * 12.3 Per Transport Address Data
874          *
875          * For each destination transport address in the peer's
876          * address list derived from the INIT or INIT ACK chunk, a
877          * number of data elements needs to be maintained including:
878          */
879         /* RTO         : The current retransmission timeout value.  */
880         unsigned long rto;
881         unsigned long last_rto;
882
883         __u32 rtt;              /* This is the most recent RTT.  */
884
885         /* RTTVAR      : The current RTT variation.  */
886         __u32 rttvar;
887
888         /* SRTT        : The current smoothed round trip time.  */
889         __u32 srtt;
890
891         /* RTO-Pending : A flag used to track if one of the DATA
892          *              chunks sent to this address is currently being
893          *              used to compute a RTT. If this flag is 0,
894          *              the next DATA chunk sent to this destination
895          *              should be used to compute a RTT and this flag
896          *              should be set. Every time the RTT
897          *              calculation completes (i.e. the DATA chunk
898          *              is SACK'd) clear this flag.
899          */
900         int rto_pending;
901
902         /*
903          * These are the congestion stats.
904          */
905         /* cwnd        : The current congestion window.  */
906         __u32 cwnd;               /* This is the actual cwnd.  */
907
908         /* ssthresh    : The current slow start threshold value.  */
909         __u32 ssthresh;
910
911         /* partial     : The tracking method for increase of cwnd when in
912          * bytes acked : congestion avoidance mode (see Section 6.2.2)
913          */
914         __u32 partial_bytes_acked;
915
916         /* Data that has been sent, but not acknowledged. */
917         __u32 flight_size;
918
919         /* Destination */
920         struct dst_entry *dst;
921         /* Source address. */
922         union sctp_addr saddr;
923
924         /* When was the last time(in jiffies) that a data packet was sent on
925          * this transport?  This is used to adjust the cwnd when the transport
926          * becomes inactive.
927          */
928         unsigned long last_time_used;
929
930         /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
931          * the destination address every heartbeat interval.
932          */
933         unsigned long hbinterval;
934
935         /* SACK delay timeout */
936         unsigned long sackdelay;
937
938         /* When was the last time (in jiffies) that we heard from this
939          * transport?  We use this to pick new active and retran paths.
940          */
941         unsigned long last_time_heard;
942
943         /* Last time(in jiffies) when cwnd is reduced due to the congestion
944          * indication based on ECNE chunk.
945          */
946         unsigned long last_time_ecne_reduced;
947
948         /* This is the max_retrans value for the transport and will
949          * be initialized from the assocs value.  This can be changed
950          * using SCTP_SET_PEER_ADDR_PARAMS socket option.
951          */
952         __u16 pathmaxrxt;
953
954         /* is the Path MTU update pending on this tranport */
955         __u8 pmtu_pending;
956
957         /* PMTU       : The current known path MTU.  */
958         __u32 pathmtu;
959
960         /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
961         __u32 param_flags;
962
963         /* The number of times INIT has been sent on this transport. */
964         int init_sent_count;
965
966         /* state       : The current state of this destination,
967          *             : i.e. SCTP_ACTIVE, SCTP_INACTIVE, SCTP_UNKOWN.
968          */
969         int state;
970
971         /* These are the error stats for this destination.  */
972
973         /* Error count : The current error count for this destination.  */
974         unsigned short error_count;
975
976         /* Per         : A timer used by each destination.
977          * Destination :
978          * Timer       :
979          *
980          * [Everywhere else in the text this is called T3-rtx. -ed]
981          */
982         struct timer_list T3_rtx_timer;
983
984         /* Heartbeat timer is per destination. */
985         struct timer_list hb_timer;
986
987         /* Since we're using per-destination retransmission timers
988          * (see above), we're also using per-destination "transmitted"
989          * queues.  This probably ought to be a private struct
990          * accessible only within the outqueue, but it's not, yet.
991          */
992         struct list_head transmitted;
993
994         /* We build bundle-able packets for this transport here.  */
995         struct sctp_packet packet;
996
997         /* This is the list of transports that have chunks to send.  */
998         struct list_head send_ready;
999
1000         int malloced; /* Is this structure kfree()able? */
1001
1002         /* State information saved for SFR_CACC algorithm. The key
1003          * idea in SFR_CACC is to maintain state at the sender on a
1004          * per-destination basis when a changeover happens.
1005          *      char changeover_active;
1006          *      char cycling_changeover;
1007          *      __u32 next_tsn_at_change;
1008          *      char cacc_saw_newack;
1009          */
1010         struct {
1011                 /* An unsigned integer, which stores the next TSN to be
1012                  * used by the sender, at the moment of changeover.
1013                  */
1014                 __u32 next_tsn_at_change;
1015
1016                 /* A flag which indicates the occurrence of a changeover */
1017                 char changeover_active;
1018
1019                 /* A flag which indicates whether the change of primary is
1020                  * the first switch to this destination address during an
1021                  * active switch.
1022                  */
1023                 char cycling_changeover;
1024
1025                 /* A temporary flag, which is used during the processing of
1026                  * a SACK to estimate the causative TSN(s)'s group.
1027                  */
1028                 char cacc_saw_newack;
1029         } cacc;
1030
1031         /* 64-bit random number sent with heartbeat. */
1032         __u64 hb_nonce;
1033 };
1034
1035 struct sctp_transport *sctp_transport_new(const union sctp_addr *,
1036                                           gfp_t);
1037 void sctp_transport_set_owner(struct sctp_transport *,
1038                               struct sctp_association *);
1039 void sctp_transport_route(struct sctp_transport *, union sctp_addr *,
1040                           struct sctp_sock *);
1041 void sctp_transport_pmtu(struct sctp_transport *);
1042 void sctp_transport_free(struct sctp_transport *);
1043 void sctp_transport_reset_timers(struct sctp_transport *);
1044 void sctp_transport_hold(struct sctp_transport *);
1045 void sctp_transport_put(struct sctp_transport *);
1046 void sctp_transport_update_rto(struct sctp_transport *, __u32);
1047 void sctp_transport_raise_cwnd(struct sctp_transport *, __u32, __u32);
1048 void sctp_transport_lower_cwnd(struct sctp_transport *, sctp_lower_cwnd_t);
1049 unsigned long sctp_transport_timeout(struct sctp_transport *);
1050 void sctp_transport_reset(struct sctp_transport *);
1051 void sctp_transport_update_pmtu(struct sctp_transport *, u32);
1052
1053
1054 /* This is the structure we use to queue packets as they come into
1055  * SCTP.  We write packets to it and read chunks from it.
1056  */
1057 struct sctp_inq {
1058         /* This is actually a queue of sctp_chunk each
1059          * containing a partially decoded packet.
1060          */
1061         struct list_head in_chunk_list;
1062         /* This is the packet which is currently off the in queue and is
1063          * being worked on through the inbound chunk processing.
1064          */
1065         struct sctp_chunk *in_progress;
1066
1067         /* This is the delayed task to finish delivering inbound
1068          * messages.
1069          */
1070         struct work_struct immediate;
1071
1072         int malloced;        /* Is this structure kfree()able?  */
1073 };
1074
1075 void sctp_inq_init(struct sctp_inq *);
1076 void sctp_inq_free(struct sctp_inq *);
1077 void sctp_inq_push(struct sctp_inq *, struct sctp_chunk *packet);
1078 struct sctp_chunk *sctp_inq_pop(struct sctp_inq *);
1079 struct sctp_chunkhdr *sctp_inq_peek(struct sctp_inq *);
1080 void sctp_inq_set_th_handler(struct sctp_inq *, work_func_t);
1081
1082 /* This is the structure we use to hold outbound chunks.  You push
1083  * chunks in and they automatically pop out the other end as bundled
1084  * packets (it calls (*output_handler)()).
1085  *
1086  * This structure covers sections 6.3, 6.4, 6.7, 6.8, 6.10, 7., 8.1,
1087  * and 8.2 of the v13 draft.
1088  *
1089  * It handles retransmissions.  The connection to the timeout portion
1090  * of the state machine is through sctp_..._timeout() and timeout_handler.
1091  *
1092  * If you feed it SACKs, it will eat them.
1093  *
1094  * If you give it big chunks, it will fragment them.
1095  *
1096  * It assigns TSN's to data chunks.  This happens at the last possible
1097  * instant before transmission.
1098  *
1099  * When free()'d, it empties itself out via output_handler().
1100  */
1101 struct sctp_outq {
1102         struct sctp_association *asoc;
1103
1104         /* Data pending that has never been transmitted.  */
1105         struct list_head out_chunk_list;
1106
1107         unsigned out_qlen;      /* Total length of queued data chunks. */
1108
1109         /* Error of send failed, may used in SCTP_SEND_FAILED event. */
1110         unsigned error;
1111
1112         /* These are control chunks we want to send.  */
1113         struct list_head control_chunk_list;
1114
1115         /* These are chunks that have been sacked but are above the
1116          * CTSN, or cumulative tsn ack point.
1117          */
1118         struct list_head sacked;
1119
1120         /* Put chunks on this list to schedule them for
1121          * retransmission.
1122          */
1123         struct list_head retransmit;
1124
1125         /* Put chunks on this list to save them for FWD TSN processing as
1126          * they were abandoned.
1127          */
1128         struct list_head abandoned;
1129
1130         /* How many unackd bytes do we have in-flight?  */
1131         __u32 outstanding_bytes;
1132
1133         /* Corked? */
1134         char cork;
1135
1136         /* Is this structure empty?  */
1137         char empty;
1138
1139         /* Are we kfree()able? */
1140         char malloced;
1141 };
1142
1143 void sctp_outq_init(struct sctp_association *, struct sctp_outq *);
1144 void sctp_outq_teardown(struct sctp_outq *);
1145 void sctp_outq_free(struct sctp_outq*);
1146 int sctp_outq_tail(struct sctp_outq *, struct sctp_chunk *chunk);
1147 int sctp_outq_flush(struct sctp_outq *, int);
1148 int sctp_outq_sack(struct sctp_outq *, struct sctp_sackhdr *);
1149 int sctp_outq_is_empty(const struct sctp_outq *);
1150 void sctp_outq_restart(struct sctp_outq *);
1151
1152 void sctp_retransmit(struct sctp_outq *, struct sctp_transport *,
1153                      sctp_retransmit_reason_t);
1154 void sctp_retransmit_mark(struct sctp_outq *, struct sctp_transport *, __u8);
1155 int sctp_outq_uncork(struct sctp_outq *);
1156 /* Uncork and flush an outqueue.  */
1157 static inline void sctp_outq_cork(struct sctp_outq *q)
1158 {
1159         q->cork = 1;
1160 }
1161
1162 /* These bind address data fields common between endpoints and associations */
1163 struct sctp_bind_addr {
1164
1165         /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1166          *
1167          * SCTP Port:   The local SCTP port number the endpoint is
1168          *              bound to.
1169          */
1170         __u16 port;
1171
1172         /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1173          *
1174          * Address List: The list of IP addresses that this instance
1175          *      has bound.  This information is passed to one's
1176          *      peer(s) in INIT and INIT ACK chunks.
1177          */
1178         struct list_head address_list;
1179
1180         int malloced;        /* Are we kfree()able?  */
1181 };
1182
1183 void sctp_bind_addr_init(struct sctp_bind_addr *, __u16 port);
1184 void sctp_bind_addr_free(struct sctp_bind_addr *);
1185 int sctp_bind_addr_copy(struct sctp_bind_addr *dest,
1186                         const struct sctp_bind_addr *src,
1187                         sctp_scope_t scope, gfp_t gfp,
1188                         int flags);
1189 int sctp_bind_addr_dup(struct sctp_bind_addr *dest,
1190                         const struct sctp_bind_addr *src,
1191                         gfp_t gfp);
1192 int sctp_add_bind_addr(struct sctp_bind_addr *, union sctp_addr *,
1193                        __u8 use_as_src, gfp_t gfp);
1194 int sctp_del_bind_addr(struct sctp_bind_addr *, union sctp_addr *);
1195 int sctp_bind_addr_match(struct sctp_bind_addr *, const union sctp_addr *,
1196                          struct sctp_sock *);
1197 union sctp_addr *sctp_find_unmatch_addr(struct sctp_bind_addr   *bp,
1198                                         const union sctp_addr   *addrs,
1199                                         int                     addrcnt,
1200                                         struct sctp_sock        *opt);
1201 union sctp_params sctp_bind_addrs_to_raw(const struct sctp_bind_addr *bp,
1202                                          int *addrs_len,
1203                                          gfp_t gfp);
1204 int sctp_raw_to_bind_addrs(struct sctp_bind_addr *bp, __u8 *raw, int len,
1205                            __u16 port, gfp_t gfp);
1206
1207 sctp_scope_t sctp_scope(const union sctp_addr *);
1208 int sctp_in_scope(const union sctp_addr *addr, const sctp_scope_t scope);
1209 int sctp_is_any(const union sctp_addr *addr);
1210 int sctp_addr_is_valid(const union sctp_addr *addr);
1211
1212
1213 /* What type of endpoint?  */
1214 typedef enum {
1215         SCTP_EP_TYPE_SOCKET,
1216         SCTP_EP_TYPE_ASSOCIATION,
1217 } sctp_endpoint_type_t;
1218
1219 /*
1220  * A common base class to bridge the implmentation view of a
1221  * socket (usually listening) endpoint versus an association's
1222  * local endpoint.
1223  * This common structure is useful for several purposes:
1224  *   1) Common interface for lookup routines.
1225  *      a) Subfunctions work for either endpoint or association
1226  *      b) Single interface to lookup allows hiding the lookup lock rather
1227  *         than acquiring it externally.
1228  *   2) Common interface for the inbound chunk handling/state machine.
1229  *   3) Common object handling routines for reference counting, etc.
1230  *   4) Disentangle association lookup from endpoint lookup, where we
1231  *      do not have to find our endpoint to find our association.
1232  *
1233  */
1234
1235 struct sctp_ep_common {
1236         /* Fields to help us manage our entries in the hash tables. */
1237         struct hlist_node node;
1238         int hashent;
1239
1240         /* Runtime type information.  What kind of endpoint is this? */
1241         sctp_endpoint_type_t type;
1242
1243         /* Some fields to help us manage this object.
1244          *   refcnt   - Reference count access to this object.
1245          *   dead     - Do not attempt to use this object.
1246          *   malloced - Do we need to kfree this object?
1247          */
1248         atomic_t    refcnt;
1249         char        dead;
1250         char        malloced;
1251
1252         /* What socket does this endpoint belong to?  */
1253         struct sock *sk;
1254
1255         /* This is where we receive inbound chunks.  */
1256         struct sctp_inq   inqueue;
1257
1258         /* This substructure includes the defining parameters of the
1259          * endpoint:
1260          * bind_addr.port is our shared port number.
1261          * bind_addr.address_list is our set of local IP addresses.
1262          */
1263         struct sctp_bind_addr bind_addr;
1264 };
1265
1266
1267 /* RFC Section 1.4 Key Terms
1268  *
1269  * o SCTP endpoint: The logical sender/receiver of SCTP packets. On a
1270  *   multi-homed host, an SCTP endpoint is represented to its peers as a
1271  *   combination of a set of eligible destination transport addresses to
1272  *   which SCTP packets can be sent and a set of eligible source
1273  *   transport addresses from which SCTP packets can be received.
1274  *   All transport addresses used by an SCTP endpoint must use the
1275  *   same port number, but can use multiple IP addresses. A transport
1276  *   address used by an SCTP endpoint must not be used by another
1277  *   SCTP endpoint. In other words, a transport address is unique
1278  *   to an SCTP endpoint.
1279  *
1280  * From an implementation perspective, each socket has one of these.
1281  * A TCP-style socket will have exactly one association on one of
1282  * these.  An UDP-style socket will have multiple associations hanging
1283  * off one of these.
1284  */
1285
1286 struct sctp_endpoint {
1287         /* Common substructure for endpoint and association. */
1288         struct sctp_ep_common base;
1289
1290         /* Associations: A list of current associations and mappings
1291          *            to the data consumers for each association. This
1292          *            may be in the form of a hash table or other
1293          *            implementation dependent structure. The data
1294          *            consumers may be process identification
1295          *            information such as file descriptors, named pipe
1296          *            pointer, or table pointers dependent on how SCTP
1297          *            is implemented.
1298          */
1299         /* This is really a list of struct sctp_association entries. */
1300         struct list_head asocs;
1301
1302         /* Secret Key: A secret key used by this endpoint to compute
1303          *            the MAC.  This SHOULD be a cryptographic quality
1304          *            random number with a sufficient length.
1305          *            Discussion in [RFC1750] can be helpful in
1306          *            selection of the key.
1307          */
1308         __u8 secret_key[SCTP_HOW_MANY_SECRETS][SCTP_SECRET_SIZE];
1309         int current_key;
1310         int last_key;
1311         int key_changed_at;
1312
1313         /* digest:  This is a digest of the sctp cookie.  This field is
1314          *          only used on the receive path when we try to validate
1315          *          that the cookie has not been tampered with.  We put
1316          *          this here so we pre-allocate this once and can re-use
1317          *          on every receive.
1318          */
1319         __u8 *digest;
1320  
1321         /* sendbuf acct. policy.        */
1322         __u32 sndbuf_policy;
1323
1324         /* rcvbuf acct. policy. */
1325         __u32 rcvbuf_policy;
1326
1327         /* SCTP AUTH: array of the HMACs that will be allocated
1328          * we need this per association so that we don't serialize
1329          */
1330         struct crypto_hash **auth_hmacs;
1331
1332         /* SCTP-AUTH: hmacs for the endpoint encoded into parameter */
1333          struct sctp_hmac_algo_param *auth_hmacs_list;
1334
1335         /* SCTP-AUTH: chunks to authenticate encoded into parameter */
1336         struct sctp_chunks_param *auth_chunk_list;
1337
1338         /* SCTP-AUTH: endpoint shared keys */
1339         struct list_head endpoint_shared_keys;
1340         __u16 active_key_id;
1341 };
1342
1343 /* Recover the outter endpoint structure. */
1344 static inline struct sctp_endpoint *sctp_ep(struct sctp_ep_common *base)
1345 {
1346         struct sctp_endpoint *ep;
1347
1348         ep = container_of(base, struct sctp_endpoint, base);
1349         return ep;
1350 }
1351
1352 /* These are function signatures for manipulating endpoints.  */
1353 struct sctp_endpoint *sctp_endpoint_new(struct sock *, gfp_t);
1354 void sctp_endpoint_free(struct sctp_endpoint *);
1355 void sctp_endpoint_put(struct sctp_endpoint *);
1356 void sctp_endpoint_hold(struct sctp_endpoint *);
1357 void sctp_endpoint_add_asoc(struct sctp_endpoint *, struct sctp_association *);
1358 struct sctp_association *sctp_endpoint_lookup_assoc(
1359         const struct sctp_endpoint *ep,
1360         const union sctp_addr *paddr,
1361         struct sctp_transport **);
1362 int sctp_endpoint_is_peeled_off(struct sctp_endpoint *,
1363                                 const union sctp_addr *);
1364 struct sctp_endpoint *sctp_endpoint_is_match(struct sctp_endpoint *,
1365                                         const union sctp_addr *);
1366 int sctp_has_association(const union sctp_addr *laddr,
1367                          const union sctp_addr *paddr);
1368
1369 int sctp_verify_init(const struct sctp_association *asoc, sctp_cid_t,
1370                      sctp_init_chunk_t *peer_init, struct sctp_chunk *chunk,
1371                      struct sctp_chunk **err_chunk);
1372 int sctp_process_init(struct sctp_association *, sctp_cid_t cid,
1373                       const union sctp_addr *peer,
1374                       sctp_init_chunk_t *init, gfp_t gfp);
1375 __u32 sctp_generate_tag(const struct sctp_endpoint *);
1376 __u32 sctp_generate_tsn(const struct sctp_endpoint *);
1377
1378 struct sctp_inithdr_host {
1379         __u32 init_tag;
1380         __u32 a_rwnd;
1381         __u16 num_outbound_streams;
1382         __u16 num_inbound_streams;
1383         __u32 initial_tsn;
1384 };
1385
1386 /* RFC2960
1387  *
1388  * 12. Recommended Transmission Control Block (TCB) Parameters
1389  *
1390  * This section details a recommended set of parameters that should
1391  * be contained within the TCB for an implementation. This section is
1392  * for illustrative purposes and should not be deemed as requirements
1393  * on an implementation or as an exhaustive list of all parameters
1394  * inside an SCTP TCB. Each implementation may need its own additional
1395  * parameters for optimization.
1396  */
1397
1398
1399 /* Here we have information about each individual association. */
1400 struct sctp_association {
1401
1402         /* A base structure common to endpoint and association.
1403          * In this context, it represents the associations's view
1404          * of the local endpoint of the association.
1405          */
1406         struct sctp_ep_common base;
1407
1408         /* Associations on the same socket. */
1409         struct list_head asocs;
1410
1411         /* association id. */
1412         sctp_assoc_t assoc_id;
1413
1414         /* This is our parent endpoint.  */
1415         struct sctp_endpoint *ep;
1416
1417         /* These are those association elements needed in the cookie.  */
1418         struct sctp_cookie c;
1419
1420         /* This is all information about our peer.  */
1421         struct {
1422                 /* rwnd
1423                  *
1424                  * Peer Rwnd   : Current calculated value of the peer's rwnd.
1425                  */
1426                 __u32 rwnd;
1427
1428                 /* transport_addr_list
1429                  *
1430                  * Peer        : A list of SCTP transport addresses that the
1431                  * Transport   : peer is bound to. This information is derived
1432                  * Address     : from the INIT or INIT ACK and is used to
1433                  * List        : associate an inbound packet with a given
1434                  *             : association. Normally this information is
1435                  *             : hashed or keyed for quick lookup and access
1436                  *             : of the TCB.
1437                  *             : The list is also initialized with the list
1438                  *             : of addresses passed with the sctp_connectx()
1439                  *             : call.
1440                  *
1441                  * It is a list of SCTP_transport's.
1442                  */
1443                 struct list_head transport_addr_list;
1444
1445                 /* transport_count
1446                  *
1447                  * Peer        : A count of the number of peer addresses
1448                  * Transport   : in the Peer Transport Address List.
1449                  * Address     :
1450                  * Count       :
1451                  */
1452                 __u16 transport_count;
1453
1454                 /* port
1455                  *   The transport layer port number.
1456                  */
1457                 __u16 port;
1458
1459                 /* primary_path
1460                  *
1461                  * Primary     : This is the current primary destination
1462                  * Path        : transport address of the peer endpoint.  It
1463                  *             : may also specify a source transport address
1464                  *             : on this endpoint.
1465                  *
1466                  * All of these paths live on transport_addr_list.
1467                  *
1468                  * At the bakeoffs, we discovered that the intent of
1469                  * primaryPath is that it only changes when the ULP
1470                  * asks to have it changed.  We add the activePath to
1471                  * designate the connection we are currently using to
1472                  * transmit new data and most control chunks.
1473                  */
1474                 struct sctp_transport *primary_path;
1475
1476                 /* Cache the primary path address here, when we
1477                  * need a an address for msg_name.
1478                  */
1479                 union sctp_addr primary_addr;
1480
1481                 /* active_path
1482                  *   The path that we are currently using to
1483                  *   transmit new data and most control chunks.
1484                  */
1485                 struct sctp_transport *active_path;
1486
1487                 /* retran_path
1488                  *
1489                  * RFC2960 6.4 Multi-homed SCTP Endpoints
1490                  * ...
1491                  * Furthermore, when its peer is multi-homed, an
1492                  * endpoint SHOULD try to retransmit a chunk to an
1493                  * active destination transport address that is
1494                  * different from the last destination address to
1495                  * which the DATA chunk was sent.
1496                  */
1497                 struct sctp_transport *retran_path;
1498
1499                 /* Pointer to last transport I have sent on.  */
1500                 struct sctp_transport *last_sent_to;
1501
1502                 /* This is the last transport I have received DATA on.  */
1503                 struct sctp_transport *last_data_from;
1504
1505                 /*
1506                  * Mapping  An array of bits or bytes indicating which out of
1507                  * Array    order TSN's have been received (relative to the
1508                  *          Last Rcvd TSN). If no gaps exist, i.e. no out of
1509                  *          order packets have been received, this array
1510                  *          will be set to all zero. This structure may be
1511                  *          in the form of a circular buffer or bit array.
1512                  *
1513                  * Last Rcvd   : This is the last TSN received in
1514                  * TSN         : sequence. This value is set initially by
1515                  *             : taking the peer's Initial TSN, received in
1516                  *             : the INIT or INIT ACK chunk, and subtracting
1517                  *             : one from it.
1518                  *
1519                  * Throughout most of the specification this is called the
1520                  * "Cumulative TSN ACK Point".  In this case, we
1521                  * ignore the advice in 12.2 in favour of the term
1522                  * used in the bulk of the text.  This value is hidden
1523                  * in tsn_map--we get it by calling sctp_tsnmap_get_ctsn().
1524                  */
1525                 struct sctp_tsnmap tsn_map;
1526                 __u8 _map[sctp_tsnmap_storage_size(SCTP_TSN_MAP_SIZE)];
1527
1528                 /* Ack State   : This flag indicates if the next received
1529                  *             : packet is to be responded to with a
1530                  *             : SACK. This is initializedto 0.  When a packet
1531                  *             : is received it is incremented. If this value
1532                  *             : reaches 2 or more, a SACK is sent and the
1533                  *             : value is reset to 0. Note: This is used only
1534                  *             : when no DATA chunks are received out of
1535                  *             : order.  When DATA chunks are out of order,
1536                  *             : SACK's are not delayed (see Section 6).
1537                  */
1538                 __u8    sack_needed;     /* Do we need to sack the peer? */
1539
1540                 /* These are capabilities which our peer advertised.  */
1541                 __u8    ecn_capable;     /* Can peer do ECN? */
1542                 __u8    ipv4_address;    /* Peer understands IPv4 addresses? */
1543                 __u8    ipv6_address;    /* Peer understands IPv6 addresses? */
1544                 __u8    hostname_address;/* Peer understands DNS addresses? */
1545                 __u8    asconf_capable;  /* Does peer support ADDIP? */
1546                 __u8    prsctp_capable;  /* Can peer do PR-SCTP? */
1547                 __u8    auth_capable;    /* Is peer doing SCTP-AUTH? */
1548
1549                 __u32   adaptation_ind;  /* Adaptation Code point. */
1550
1551                 /* This mask is used to disable sending the ASCONF chunk
1552                  * with specified parameter to peer.
1553                  */
1554                 __be16 addip_disabled_mask;
1555
1556                 struct sctp_inithdr_host i;
1557                 int cookie_len;
1558                 void *cookie;
1559
1560                 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
1561                  * C1) ... "Peer-Serial-Number'. This value MUST be initialized to the
1562                  * Initial TSN Value minus 1
1563                  */
1564                 __u32 addip_serial;
1565
1566                 /* SCTP-AUTH: We need to know pears random number, hmac list
1567                  * and authenticated chunk list.  All that is part of the
1568                  * cookie and these are just pointers to those locations
1569                  */
1570                 sctp_random_param_t *peer_random;
1571                 sctp_chunks_param_t *peer_chunks;
1572                 sctp_hmac_algo_param_t *peer_hmacs;
1573         } peer;
1574
1575         /* State       : A state variable indicating what state the
1576          *             : association is in, i.e. COOKIE-WAIT,
1577          *             : COOKIE-ECHOED, ESTABLISHED, SHUTDOWN-PENDING,
1578          *             : SHUTDOWN-SENT, SHUTDOWN-RECEIVED, SHUTDOWN-ACK-SENT.
1579          *
1580          *              Note: No "CLOSED" state is illustrated since if a
1581          *              association is "CLOSED" its TCB SHOULD be removed.
1582          *
1583          *              In this implementation we DO have a CLOSED
1584          *              state which is used during initiation and shutdown.
1585          *
1586          *              State takes values from SCTP_STATE_*.
1587          */
1588         sctp_state_t state;
1589
1590         /* The cookie life I award for any cookie.  */
1591         struct timeval cookie_life;
1592
1593         /* Overall     : The overall association error count.
1594          * Error Count : [Clear this any time I get something.]
1595          */
1596         int overall_error_count;
1597
1598         /* These are the association's initial, max, and min RTO values.
1599          * These values will be initialized by system defaults, but can
1600          * be modified via the SCTP_RTOINFO socket option.
1601          */
1602         unsigned long rto_initial;
1603         unsigned long rto_max;
1604         unsigned long rto_min;
1605
1606         /* Maximum number of new data packets that can be sent in a burst.  */
1607         int max_burst;
1608
1609         /* This is the max_retrans value for the association.  This value will
1610          * be initialized initialized from system defaults, but can be
1611          * modified by the SCTP_ASSOCINFO socket option.
1612          */
1613         int max_retrans;
1614
1615         /* Maximum number of times the endpoint will retransmit INIT  */
1616         __u16 max_init_attempts;
1617
1618         /* How many times have we resent an INIT? */
1619         __u16 init_retries;
1620
1621         /* The largest timeout or RTO value to use in attempting an INIT */
1622         unsigned long max_init_timeo;
1623
1624         /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
1625          * the destination address every heartbeat interval. This value
1626          * will be inherited by all new transports.
1627          */
1628         unsigned long hbinterval;
1629
1630         /* This is the max_retrans value for new transports in the
1631          * association.
1632          */
1633         __u16 pathmaxrxt;
1634
1635         /* Flag that path mtu update is pending */
1636         __u8   pmtu_pending;
1637
1638         /* Association : The smallest PMTU discovered for all of the
1639          * PMTU        : peer's transport addresses.
1640          */
1641         __u32 pathmtu;
1642
1643         /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
1644         __u32 param_flags;
1645
1646         /* SACK delay timeout */
1647         unsigned long sackdelay;
1648
1649
1650         unsigned long timeouts[SCTP_NUM_TIMEOUT_TYPES];
1651         struct timer_list timers[SCTP_NUM_TIMEOUT_TYPES];
1652
1653         /* Transport to which SHUTDOWN chunk was last sent.  */
1654         struct sctp_transport *shutdown_last_sent_to;
1655
1656         /* Transport to which INIT chunk was last sent.  */
1657         struct sctp_transport *init_last_sent_to;
1658
1659         /* Next TSN    : The next TSN number to be assigned to a new
1660          *             : DATA chunk.  This is sent in the INIT or INIT
1661          *             : ACK chunk to the peer and incremented each
1662          *             : time a DATA chunk is assigned a TSN
1663          *             : (normally just prior to transmit or during
1664          *             : fragmentation).
1665          */
1666         __u32 next_tsn;
1667
1668         /*
1669          * Last Rcvd   : This is the last TSN received in sequence.  This value
1670          * TSN         : is set initially by taking the peer's Initial TSN,
1671          *             : received in the INIT or INIT ACK chunk, and
1672          *             : subtracting one from it.
1673          *
1674          * Most of RFC 2960 refers to this as the Cumulative TSN Ack Point.
1675          */
1676
1677         __u32 ctsn_ack_point;
1678
1679         /* PR-SCTP Advanced.Peer.Ack.Point */
1680         __u32 adv_peer_ack_point;
1681
1682         /* Highest TSN that is acknowledged by incoming SACKs. */
1683         __u32 highest_sacked;
1684
1685         /* The number of unacknowledged data chunks.  Reported through
1686          * the SCTP_STATUS sockopt.
1687          */
1688         __u16 unack_data;
1689
1690         /* This is the association's receive buffer space.  This value is used
1691          * to set a_rwnd field in an INIT or a SACK chunk.
1692          */
1693         __u32 rwnd;
1694
1695         /* This is the last advertised value of rwnd over a SACK chunk. */
1696         __u32 a_rwnd;
1697
1698         /* Number of bytes by which the rwnd has slopped.  The rwnd is allowed
1699          * to slop over a maximum of the association's frag_point.
1700          */
1701         __u32 rwnd_over;
1702
1703         /* This is the sndbuf size in use for the association.
1704          * This corresponds to the sndbuf size for the association,
1705          * as specified in the sk->sndbuf.
1706          */
1707         int sndbuf_used;
1708
1709         /* This is the amount of memory that this association has allocated
1710          * in the receive path at any given time.
1711          */
1712         atomic_t rmem_alloc;
1713
1714         /* This is the wait queue head for send requests waiting on
1715          * the association sndbuf space.
1716          */
1717         wait_queue_head_t       wait;
1718
1719         /* The message size at which SCTP fragmentation will occur. */
1720         __u32 frag_point;
1721
1722         /* Counter used to count INIT errors. */
1723         int init_err_counter;
1724
1725         /* Count the number of INIT cycles (for doubling timeout). */
1726         int init_cycle;
1727
1728         /* Default send parameters. */
1729         __u16 default_stream;
1730         __u16 default_flags;
1731         __u32 default_ppid;
1732         __u32 default_context;
1733         __u32 default_timetolive;
1734
1735         /* Default receive parameters */
1736         __u32 default_rcv_context;
1737
1738         /* This tracks outbound ssn for a given stream.  */
1739         struct sctp_ssnmap *ssnmap;
1740
1741         /* All outbound chunks go through this structure.  */
1742         struct sctp_outq outqueue;
1743
1744         /* A smart pipe that will handle reordering and fragmentation,
1745          * as well as handle passing events up to the ULP.
1746          */
1747         struct sctp_ulpq ulpq;
1748
1749         /* Last TSN that caused an ECNE Chunk to be sent.  */
1750         __u32 last_ecne_tsn;
1751
1752         /* Last TSN that caused a CWR Chunk to be sent.  */
1753         __u32 last_cwr_tsn;
1754
1755         /* How many duplicated TSNs have we seen?  */
1756         int numduptsns;
1757
1758         /* Number of seconds of idle time before an association is closed.
1759          * In the association context, this is really used as a boolean
1760          * since the real timeout is stored in the timeouts array
1761          */
1762         __u32 autoclose;
1763
1764         /* These are to support
1765          * "SCTP Extensions for Dynamic Reconfiguration of IP Addresses
1766          *  and Enforcement of Flow and Message Limits"
1767          * <draft-ietf-tsvwg-addip-sctp-02.txt>
1768          * or "ADDIP" for short.
1769          */
1770
1771
1772
1773         /* ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1774          *
1775          * R1) One and only one ASCONF Chunk MAY be in transit and
1776          * unacknowledged at any one time.  If a sender, after sending
1777          * an ASCONF chunk, decides it needs to transfer another
1778          * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1779          * returns from the previous ASCONF Chunk before sending a
1780          * subsequent ASCONF. Note this restriction binds each side,
1781          * so at any time two ASCONF may be in-transit on any given
1782          * association (one sent from each endpoint).
1783          *
1784          * [This is our one-and-only-one ASCONF in flight.  If we do
1785          * not have an ASCONF in flight, this is NULL.]
1786          */
1787         struct sctp_chunk *addip_last_asconf;
1788
1789         /* ADDIP Section 5.2 Upon reception of an ASCONF Chunk.
1790          *
1791          * This is needed to implement itmes E1 - E4 of the updated
1792          * spec.  Here is the justification:
1793          *
1794          * Since the peer may bundle multiple ASCONF chunks toward us,
1795          * we now need the ability to cache multiple ACKs.  The section
1796          * describes in detail how they are cached and cleaned up.
1797          */
1798         struct list_head asconf_ack_list;
1799
1800         /* These ASCONF chunks are waiting to be sent.
1801          *
1802          * These chunaks can't be pushed to outqueue until receiving
1803          * ASCONF_ACK for the previous ASCONF indicated by
1804          * addip_last_asconf, so as to guarantee that only one ASCONF
1805          * is in flight at any time.
1806          *
1807          * ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1808          *
1809          * In defining the ASCONF Chunk transfer procedures, it is
1810          * essential that these transfers MUST NOT cause congestion
1811          * within the network.  To achieve this, we place these
1812          * restrictions on the transfer of ASCONF Chunks:
1813          *
1814          * R1) One and only one ASCONF Chunk MAY be in transit and
1815          * unacknowledged at any one time.  If a sender, after sending
1816          * an ASCONF chunk, decides it needs to transfer another
1817          * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1818          * returns from the previous ASCONF Chunk before sending a
1819          * subsequent ASCONF. Note this restriction binds each side,
1820          * so at any time two ASCONF may be in-transit on any given
1821          * association (one sent from each endpoint).
1822          *
1823          *
1824          * [I really think this is EXACTLY the sort of intelligence
1825          *  which already resides in sctp_outq.  Please move this
1826          *  queue and its supporting logic down there.  --piggy]
1827          */
1828         struct list_head addip_chunk_list;
1829
1830         /* ADDIP Section 4.1 ASCONF Chunk Procedures
1831          *
1832          * A2) A serial number should be assigned to the Chunk. The
1833          * serial number SHOULD be a monotonically increasing
1834          * number. The serial number SHOULD be initialized at
1835          * the start of the association to the same value as the
1836          * Initial TSN and every time a new ASCONF chunk is created
1837          * it is incremented by one after assigning the serial number
1838          * to the newly created chunk.
1839          *
1840          * ADDIP
1841          * 3.1.1  Address/Stream Configuration Change Chunk (ASCONF)
1842          *
1843          * Serial Number : 32 bits (unsigned integer)
1844          *
1845          * This value represents a Serial Number for the ASCONF
1846          * Chunk. The valid range of Serial Number is from 0 to
1847          * 4294967295 (2^32 - 1).  Serial Numbers wrap back to 0
1848          * after reaching 4294967295.
1849          */
1850         __u32 addip_serial;
1851
1852         /* SCTP AUTH: list of the endpoint shared keys.  These
1853          * keys are provided out of band by the user applicaton
1854          * and can't change during the lifetime of the association
1855          */
1856         struct list_head endpoint_shared_keys;
1857
1858         /* SCTP AUTH:
1859          * The current generated assocaition shared key (secret)
1860          */
1861         struct sctp_auth_bytes *asoc_shared_key;
1862
1863         /* SCTP AUTH: hmac id of the first peer requested algorithm
1864          * that we support.
1865          */
1866         __u16 default_hmac_id;
1867
1868         __u16 active_key_id;
1869
1870         /* Need to send an ECNE Chunk? */
1871         char need_ecne;
1872
1873         /* Is it a temporary association? */
1874         char temp;
1875 };
1876
1877
1878 /* An eyecatcher for determining if we are really looking at an
1879  * association data structure.
1880  */
1881 enum {
1882         SCTP_ASSOC_EYECATCHER = 0xa550c123,
1883 };
1884
1885 /* Recover the outter association structure. */
1886 static inline struct sctp_association *sctp_assoc(struct sctp_ep_common *base)
1887 {
1888         struct sctp_association *asoc;
1889
1890         asoc = container_of(base, struct sctp_association, base);
1891         return asoc;
1892 }
1893
1894 /* These are function signatures for manipulating associations.  */
1895
1896
1897 struct sctp_association *
1898 sctp_association_new(const struct sctp_endpoint *, const struct sock *,
1899                      sctp_scope_t scope, gfp_t gfp);
1900 void sctp_association_free(struct sctp_association *);
1901 void sctp_association_put(struct sctp_association *);
1902 void sctp_association_hold(struct sctp_association *);
1903
1904 struct sctp_transport *sctp_assoc_choose_init_transport(
1905         struct sctp_association *);
1906 struct sctp_transport *sctp_assoc_choose_shutdown_transport(
1907         struct sctp_association *);
1908 void sctp_assoc_update_retran_path(struct sctp_association *);
1909 struct sctp_transport *sctp_assoc_lookup_paddr(const struct sctp_association *,
1910                                           const union sctp_addr *);
1911 int sctp_assoc_lookup_laddr(struct sctp_association *asoc,
1912                             const union sctp_addr *laddr);
1913 struct sctp_transport *sctp_assoc_add_peer(struct sctp_association *,
1914                                      const union sctp_addr *address,
1915                                      const gfp_t gfp,
1916                                      const int peer_state);
1917 void sctp_assoc_del_peer(struct sctp_association *asoc,
1918                          const union sctp_addr *addr);
1919 void sctp_assoc_rm_peer(struct sctp_association *asoc,
1920                          struct sctp_transport *peer);
1921 void sctp_assoc_control_transport(struct sctp_association *,
1922                                   struct sctp_transport *,
1923                                   sctp_transport_cmd_t, sctp_sn_error_t);
1924 struct sctp_transport *sctp_assoc_lookup_tsn(struct sctp_association *, __u32);
1925 struct sctp_transport *sctp_assoc_is_match(struct sctp_association *,
1926                                            const union sctp_addr *,
1927                                            const union sctp_addr *);
1928 void sctp_assoc_migrate(struct sctp_association *, struct sock *);
1929 void sctp_assoc_update(struct sctp_association *old,
1930                        struct sctp_association *new);
1931
1932 __u32 sctp_association_get_next_tsn(struct sctp_association *);
1933
1934 void sctp_assoc_sync_pmtu(struct sctp_association *);
1935 void sctp_assoc_rwnd_increase(struct sctp_association *, unsigned);
1936 void sctp_assoc_rwnd_decrease(struct sctp_association *, unsigned);
1937 void sctp_assoc_set_primary(struct sctp_association *,
1938                             struct sctp_transport *);
1939 void sctp_assoc_del_nonprimary_peers(struct sctp_association *,
1940                                     struct sctp_transport *);
1941 int sctp_assoc_set_bind_addr_from_ep(struct sctp_association *,
1942                                      gfp_t);
1943 int sctp_assoc_set_bind_addr_from_cookie(struct sctp_association *,
1944                                          struct sctp_cookie*,
1945                                          gfp_t gfp);
1946 int sctp_assoc_set_id(struct sctp_association *, gfp_t);
1947 void sctp_assoc_clean_asconf_ack_cache(const struct sctp_association *asoc);
1948 struct sctp_chunk *sctp_assoc_lookup_asconf_ack(
1949                                         const struct sctp_association *asoc,
1950                                         __be32 serial);
1951
1952
1953 int sctp_cmp_addr_exact(const union sctp_addr *ss1,
1954                         const union sctp_addr *ss2);
1955 struct sctp_chunk *sctp_get_ecne_prepend(struct sctp_association *asoc);
1956
1957 /* A convenience structure to parse out SCTP specific CMSGs. */
1958 typedef struct sctp_cmsgs {
1959         struct sctp_initmsg *init;
1960         struct sctp_sndrcvinfo *info;
1961 } sctp_cmsgs_t;
1962
1963 /* Structure for tracking memory objects */
1964 typedef struct {
1965         char *label;
1966         atomic_t *counter;
1967 } sctp_dbg_objcnt_entry_t;
1968
1969 #endif /* __sctp_structs_h__ */