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