include/net/sctp/structs.h

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