include/net/sctp/structs.h

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