include/net/sctp/structs.h

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