include/net/sctp/structs.h

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