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