OpenCores
URL https://opencores.org/ocsvn/or1k/or1k/trunk

Subversion Repositories or1k

[/] [or1k/] [trunk/] [linux/] [linux-2.4/] [include/] [net/] [sctp/] [structs.h] - Blame information for rev 1765

Details | Compare with Previous | View Log

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

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.