include/net/sctp/structs.h

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