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