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