include/net/sctp/structs.h

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