home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / src / linux-headers-2.6.17-6 / include / net / sctp / structs.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-08-11  |  58.6 KB  |  1,863 lines

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