Pileus Git - ~andy/linux/blob - include/net/sctp/structs.h

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