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