xref: /titanic_44/usr/src/uts/common/inet/sctp/sctp_impl.h (revision 160124a620427e5bf36392463283ed0a830a4f47)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_INET_SCTP_SCTP_IMPL_H
28 #define	_INET_SCTP_SCTP_IMPL_H
29 
30 #include <sys/inttypes.h>
31 #include <sys/taskq.h>
32 #include <sys/list.h>
33 #include <sys/strsun.h>
34 #include <sys/zone.h>
35 #include <netinet/ip6.h>
36 #include <inet/optcom.h>
37 #include <netinet/sctp.h>
38 #include <inet/sctp_itf.h>
39 #include "sctp_stack.h"
40 
41 #ifdef	__cplusplus
42 extern "C" {
43 #endif
44 
45 /* Streams device identifying info and version */
46 #define	SCTP_DEV_IDINFO	"SCTP Streams device 1.0"
47 
48 #define	SSN_GT(a, b)	((int16_t)((a)-(b)) > 0)
49 #define	SSN_GE(a, b)	((int16_t)((a)-(b)) >= 0)
50 
51 /* Default buffer size and flow control wake up threshold. */
52 #define	SCTP_XMIT_LOWATER	8192
53 #define	SCTP_XMIT_HIWATER	102400
54 #define	SCTP_RECV_LOWATER	8192
55 #define	SCTP_RECV_HIWATER	102400
56 
57 /* SCTP Timer control structure */
58 typedef struct sctpt_s {
59 	pfv_t	sctpt_pfv;	/* The routine we are to call */
60 	struct sctp_s *sctpt_sctp;	/* The parameter we are to pass in */
61 	struct sctp_faddr_s *sctpt_faddr;
62 } sctpt_t;
63 
64 /*
65  * Maximum number of duplicate TSNs we can report. This is currently
66  * static, and governs the size of the mblk used to hold the duplicate
67  * reports. The use of duplcate TSN reports is currently experimental,
68  * so for now a static limit should suffice.
69  */
70 #define	SCTP_DUP_MBLK_SZ	64
71 
72 #define	SCTP_IS_ADDR_UNSPEC(isv4, addr)		\
73 	((isv4) ? IN6_IS_ADDR_V4MAPPED_ANY(&(addr)) :	\
74 	IN6_IS_ADDR_UNSPECIFIED(&(addr)))
75 
76 /*
77  * SCTP parameters
78  */
79 /* Named Dispatch Parameter Management Structure */
80 typedef struct sctpparam_s {
81 	uint32_t	sctp_param_min;
82 	uint32_t	sctp_param_max;
83 	uint32_t	sctp_param_val;
84 	char		*sctp_param_name;
85 } sctpparam_t;
86 
87 #define	sctps_max_init_retr		sctps_params[0].sctp_param_val
88 #define	sctps_max_init_retr_high	sctps_params[0].sctp_param_max
89 #define	sctps_max_init_retr_low		sctps_params[0].sctp_param_min
90 #define	sctps_pa_max_retr		sctps_params[1].sctp_param_val
91 #define	sctps_pa_max_retr_high		sctps_params[1].sctp_param_max
92 #define	sctps_pa_max_retr_low		sctps_params[1].sctp_param_min
93 #define	sctps_pp_max_retr		sctps_params[2].sctp_param_val
94 #define	sctps_pp_max_retr_high		sctps_params[2].sctp_param_max
95 #define	sctps_pp_max_retr_low		sctps_params[2].sctp_param_min
96 #define	sctps_cwnd_max_			sctps_params[3].sctp_param_val
97 #define	__sctps_not_used1		sctps_params[4].sctp_param_val
98 #define	sctps_smallest_nonpriv_port	sctps_params[5].sctp_param_val
99 #define	sctps_ipv4_ttl			sctps_params[6].sctp_param_val
100 #define	sctps_heartbeat_interval	sctps_params[7].sctp_param_val
101 #define	sctps_heartbeat_interval_high	sctps_params[7].sctp_param_max
102 #define	sctps_heartbeat_interval_low	sctps_params[7].sctp_param_min
103 #define	sctps_initial_mtu		sctps_params[8].sctp_param_val
104 #define	sctps_mtu_probe_interval	sctps_params[9].sctp_param_val
105 #define	sctps_new_secret_interval	sctps_params[10].sctp_param_val
106 #define	sctps_deferred_ack_interval	sctps_params[11].sctp_param_val
107 #define	sctps_snd_lowat_fraction	sctps_params[12].sctp_param_val
108 #define	sctps_ignore_path_mtu		sctps_params[13].sctp_param_val
109 #define	sctps_initial_ssthresh		sctps_params[14].sctp_param_val
110 #define	sctps_smallest_anon_port	sctps_params[15].sctp_param_val
111 #define	sctps_largest_anon_port		sctps_params[16].sctp_param_val
112 #define	sctps_xmit_hiwat		sctps_params[17].sctp_param_val
113 #define	sctps_xmit_lowat		sctps_params[18].sctp_param_val
114 #define	sctps_recv_hiwat		sctps_params[19].sctp_param_val
115 #define	sctps_max_buf			sctps_params[20].sctp_param_val
116 #define	sctps_rtt_updates		sctps_params[21].sctp_param_val
117 #define	sctps_ipv6_hoplimit		sctps_params[22].sctp_param_val
118 #define	sctps_rto_ming			sctps_params[23].sctp_param_val
119 #define	sctps_rto_ming_high		sctps_params[23].sctp_param_max
120 #define	sctps_rto_ming_low		sctps_params[23].sctp_param_min
121 #define	sctps_rto_maxg			sctps_params[24].sctp_param_val
122 #define	sctps_rto_maxg_high		sctps_params[24].sctp_param_max
123 #define	sctps_rto_maxg_low		sctps_params[24].sctp_param_min
124 #define	sctps_rto_initialg		sctps_params[25].sctp_param_val
125 #define	sctps_rto_initialg_high		sctps_params[25].sctp_param_max
126 #define	sctps_rto_initialg_low		sctps_params[25].sctp_param_min
127 #define	sctps_cookie_life		sctps_params[26].sctp_param_val
128 #define	sctps_cookie_life_high		sctps_params[26].sctp_param_max
129 #define	sctps_cookie_life_low		sctps_params[26].sctp_param_min
130 #define	sctps_max_in_streams		sctps_params[27].sctp_param_val
131 #define	sctps_max_in_streams_high	sctps_params[27].sctp_param_max
132 #define	sctps_max_in_streams_low	sctps_params[27].sctp_param_min
133 #define	sctps_initial_out_streams	sctps_params[28].sctp_param_val
134 #define	sctps_initial_out_streams_high	sctps_params[28].sctp_param_max
135 #define	sctps_initial_out_streams_low	sctps_params[28].sctp_param_min
136 #define	sctps_shutack_wait_bound	sctps_params[29].sctp_param_val
137 #define	sctps_maxburst			sctps_params[30].sctp_param_val
138 #define	sctps_addip_enabled		sctps_params[31].sctp_param_val
139 #define	sctps_recv_hiwat_minmss		sctps_params[32].sctp_param_val
140 #define	sctps_slow_start_initial	sctps_params[33].sctp_param_val
141 #define	sctps_slow_start_after_idle	sctps_params[34].sctp_param_val
142 #define	sctps_prsctp_enabled		sctps_params[35].sctp_param_val
143 #define	sctps_fast_rxt_thresh		sctps_params[36].sctp_param_val
144 #define	sctps_deferred_acks_max		sctps_params[37].sctp_param_val
145 
146 /*
147  * sctp_wroff_xtra is the extra space in front of SCTP/IP header for link
148  * layer header.  It has to be a multiple of 4.
149  */
150 #define	sctps_wroff_xtra	sctps_wroff_xtra_param->sctp_param_val
151 
152 /*
153  * Retransmission timer start and stop macro for a given faddr.
154  */
155 #define	SCTP_FADDR_TIMER_RESTART(sctp, fp, intvl)			\
156 {									\
157 	dprint(3, ("faddr_timer_restart: fp=%p %x:%x:%x:%x %d\n",	\
158 	    (void *)(fp), SCTP_PRINTADDR((fp)->faddr), (int)(intvl)));	\
159 	sctp_timer((sctp), (fp)->timer_mp, (intvl));			\
160 	(fp)->timer_running = 1;					\
161 }
162 
163 #define	SCTP_FADDR_TIMER_STOP(fp)			\
164 	ASSERT((fp)->timer_mp != NULL);			\
165 	if ((fp)->timer_running) {			\
166 		sctp_timer_stop((fp)->timer_mp);	\
167 		(fp)->timer_running = 0;		\
168 	}
169 
170 /* For per endpoint association statistics */
171 #define	SCTP_MAX_RTO(sctp, fp) {			\
172 	/*						\
173 	 * Record the maximum observed RTO,		\
174 	 * sctp_maxrto is zeroed elsewhere		\
175 	 * at the end of each stats request.		\
176 	 */						\
177 	(sctp)->sctp_maxrto =				\
178 	    MAX((sctp)->sctp_maxrto, (fp)->rto);	\
179 	DTRACE_PROBE2(sctp__maxrto, sctp_t *,		\
180 	    sctp, struct sctp_faddr_s, fp);		\
181 }
182 
183 #define	SCTP_CALC_RXT(sctp, fp)				\
184 {							\
185 	if (((fp)->rto <<= 1) > (sctp)->sctp_rto_max)	\
186 		(fp)->rto = (sctp)->sctp_rto_max;	\
187 	SCTP_MAX_RTO(sctp, fp);				\
188 }
189 
190 
191 #define	SCTP_MAX_COMBINED_HEADER_LENGTH	(60 + 12) /* Maxed out ip + sctp */
192 #define	SCTP_MAX_IP_OPTIONS_LENGTH	(60 - IP_SIMPLE_HDR_LENGTH)
193 #define	SCTP_MAX_HDR_LENGTH		60
194 
195 #define	SCTP_SECRET_LEN	16
196 
197 #define	SCTP_REFHOLD(sctp) {				\
198 	mutex_enter(&(sctp)->sctp_reflock);		\
199 	(sctp)->sctp_refcnt++;				\
200 	DTRACE_PROBE1(sctp_refhold, sctp_t, sctp);	\
201 	ASSERT((sctp)->sctp_refcnt != 0);		\
202 	mutex_exit(&(sctp)->sctp_reflock);		\
203 }
204 
205 #define	SCTP_REFRELE(sctp) {					\
206 	mutex_enter(&(sctp)->sctp_reflock);			\
207 	ASSERT((sctp)->sctp_refcnt != 0);			\
208 	if (--(sctp)->sctp_refcnt == 0) {			\
209 		DTRACE_PROBE1(sctp_refrele, sctp_t, sctp);	\
210 		mutex_exit(&(sctp)->sctp_reflock);		\
211 		CONN_DEC_REF((sctp)->sctp_connp);		\
212 	} else {						\
213 		DTRACE_PROBE1(sctp_refrele, sctp_t, sctp);	\
214 		mutex_exit(&(sctp)->sctp_reflock);		\
215 	}							\
216 }
217 
218 #define	SCTP_PRINTADDR(a)	(a).s6_addr32[0], (a).s6_addr32[1],\
219 				(a).s6_addr32[2], (a).s6_addr32[3]
220 
221 #define	CONN2SCTP(conn)	((sctp_t *)(&((conn_t *)conn)[1]))
222 
223 /*
224  * Outbound data, flags and macros for per-message, per-chunk info
225  */
226 typedef struct {
227 	int64_t		smh_ttl;		/* Time to Live */
228 	int64_t		smh_tob;		/* Time of Birth */
229 	uint32_t	smh_context;
230 	uint16_t	smh_sid;
231 	uint16_t	smh_ssn;
232 	uint32_t	smh_ppid;
233 	uint16_t	smh_flags;
234 	uint32_t	smh_msglen;
235 } sctp_msg_hdr_t;
236 
237 #define	SCTP_CHUNK_FLAG_SENT		0x01
238 #define	SCTP_CHUNK_FLAG_REXMIT		0x02
239 #define	SCTP_CHUNK_FLAG_ACKED		0x04
240 #define	SCTP_MSG_FLAG_CHUNKED		0x08
241 #define	SCTP_MSG_FLAG_ABANDONED		0x10
242 #define	SCTP_CHUNK_FLAG_ABANDONED	0x20
243 
244 #define	SCTP_CHUNK_CLEAR_FLAGS(mp) ((mp)->b_flag = 0)
245 /*
246  * If we are transmitting the chunk for the first time we assign the TSN and
247  * SSN here. The reason we assign the SSN here (as opposed to doing it in
248  * sctp_chunkify()) is that the chunk may expire, if PRSCTP is enabled, before
249  * we get a chance to send it out. If we assign the SSN in sctp_chunkify()
250  * and this happens, then we need to send a Forward TSN to the peer, which
251  * will be expecting this SSN, assuming ordered. If we assign it here we
252  * can just take out the chunk from the transmit list without having to
253  * send a Forward TSN chunk. While assigning the SSN we use (meta)->b_cont
254  * to determine if it needs a new SSN (i.e. the next SSN for the stream),
255  * since (meta)->b_cont signifies the first chunk of a message (if the message
256  * is unordered, then the SSN is 0).
257  *
258  */
259 #define	SCTP_CHUNK_SENT(sctp, mp, sdc, fp, chunkdata, meta) {		\
260 	if (!SCTP_CHUNK_ISSENT(mp)) {					\
261 		sctp_msg_hdr_t	*mhdr = (sctp_msg_hdr_t *)(meta)->b_rptr; \
262 		ASSERT(!SCTP_CHUNK_ABANDONED(mp));			\
263 		(mp)->b_flag = SCTP_CHUNK_FLAG_SENT;			\
264 		(sdc)->sdh_tsn = htonl((sctp)->sctp_ltsn++);		\
265 		if ((mhdr)->smh_flags & MSG_UNORDERED) {		\
266 			(sdc)->sdh_ssn = 0;				\
267 			SCTP_DATA_SET_UBIT(sdc);			\
268 			BUMP_LOCAL((sctp)->sctp_oudchunks);		\
269 		} else {						\
270 			BUMP_LOCAL((sctp)->sctp_odchunks);		\
271 			if ((mp) == (meta)->b_cont) {			\
272 				mhdr->smh_ssn = htons(			\
273 				    (sctp)->sctp_ostrcntrs[mhdr->smh_sid]++); \
274 			}						\
275 			(sdc)->sdh_ssn = mhdr->smh_ssn;			\
276 		}							\
277 		(sctp)->sctp_unacked += (chunkdata);			\
278 		(sctp)->sctp_unsent -= (chunkdata);			\
279 		(sctp)->sctp_frwnd -= (chunkdata);			\
280 	} else {							\
281 		if (SCTP_CHUNK_ISACKED(mp)) {				\
282 			(sctp)->sctp_unacked += (chunkdata);		\
283 		} else {						\
284 			ASSERT(SCTP_CHUNK_DEST(mp)->suna >= ((chunkdata) + \
285 							sizeof (*sdc))); \
286 			SCTP_CHUNK_DEST(mp)->suna -= ((chunkdata) + 	\
287 					sizeof (*sdc));			\
288 		}							\
289 		(mp)->b_flag &= ~(SCTP_CHUNK_FLAG_REXMIT |		\
290 			SCTP_CHUNK_FLAG_ACKED);				\
291 		SCTP_CHUNK_SET_SACKCNT(mp, 0);				\
292 		BUMP_LOCAL(sctp->sctp_rxtchunks);			\
293 		BUMP_LOCAL((sctp)->sctp_T3expire);			\
294 		BUMP_LOCAL((fp)->T3expire);				\
295 	}								\
296 	SCTP_SET_CHUNK_DEST(mp, fp);					\
297 	(fp)->suna += ((chunkdata) + sizeof (*sdc));			\
298 }
299 
300 #define	SCTP_CHUNK_ISSENT(mp)	((mp)->b_flag & SCTP_CHUNK_FLAG_SENT)
301 #define	SCTP_CHUNK_CANSEND(mp)	\
302 	(!(SCTP_CHUNK_ABANDONED(mp)) &&	\
303 	(((mp)->b_flag & (SCTP_CHUNK_FLAG_REXMIT|SCTP_CHUNK_FLAG_SENT)) != \
304 	SCTP_CHUNK_FLAG_SENT))
305 
306 #define	SCTP_CHUNK_DEST(mp)		((sctp_faddr_t *)(mp)->b_queue)
307 #define	SCTP_SET_CHUNK_DEST(mp, fp)	((mp)->b_queue = (queue_t *)fp)
308 
309 #define	SCTP_CHUNK_REXMIT(mp)	((mp)->b_flag |= SCTP_CHUNK_FLAG_REXMIT)
310 #define	SCTP_CHUNK_CLEAR_REXMIT(mp) ((mp)->b_flag &= ~SCTP_CHUNK_FLAG_REXMIT)
311 #define	SCTP_CHUNK_WANT_REXMIT(mp) ((mp)->b_flag & SCTP_CHUNK_FLAG_REXMIT)
312 
313 #define	SCTP_CHUNK_ACKED(mp) \
314 	((mp)->b_flag = (SCTP_CHUNK_FLAG_SENT|SCTP_CHUNK_FLAG_ACKED))
315 #define	SCTP_CHUNK_ISACKED(mp)	((mp)->b_flag & SCTP_CHUNK_FLAG_ACKED)
316 #define	SCTP_CHUNK_CLEAR_ACKED(mp) ((mp)->b_flag &= ~SCTP_CHUNK_FLAG_ACKED)
317 
318 #define	SCTP_CHUNK_SACKCNT(mp)	((intptr_t)((mp)->b_prev))
319 #define	SCTP_CHUNK_SET_SACKCNT(mp, val) ((mp)->b_prev = \
320 					(mblk_t *)(uintptr_t)(val))
321 
322 #define	SCTP_MSG_SET_CHUNKED(mp)	((mp)->b_flag |= SCTP_MSG_FLAG_CHUNKED)
323 #define	SCTP_MSG_CLEAR_CHUNKED(mp)((mp)->b_flag &= ~SCTP_MSG_FLAG_CHUNKED)
324 #define	SCTP_IS_MSG_CHUNKED(mp)	((mp)->b_flag & SCTP_MSG_FLAG_CHUNKED)
325 
326 /* For PR-SCTP */
327 #define	SCTP_ABANDON_CHUNK(mp)	((mp)->b_flag |= SCTP_CHUNK_FLAG_ABANDONED)
328 #define	SCTP_CHUNK_ABANDONED(mp) \
329 	((mp)->b_flag & SCTP_CHUNK_FLAG_ABANDONED)
330 
331 #define	SCTP_MSG_SET_ABANDONED(mp)	\
332 	((mp)->b_flag |= SCTP_MSG_FLAG_ABANDONED)
333 #define	SCTP_MSG_CLEAR_ABANDONED(mp)((mp)->b_flag &= ~SCTP_MSG_FLAG_ABANDONED)
334 #define	SCTP_IS_MSG_ABANDONED(mp)	((mp)->b_flag & SCTP_MSG_FLAG_ABANDONED)
335 
336 /*
337  * Check if a message has expired.  A message is expired if
338  *	1. It has a non-zero time to live value and has not been sent before
339  *	that time expires.
340  *	2. It is sent using PRSCTP and it has not been SACK'ed before
341  *	its lifetime expires.
342  */
343 #define	SCTP_MSG_TO_BE_ABANDONED(meta, mhdr, sctp)			     \
344 	(((!SCTP_CHUNK_ISSENT((meta)->b_cont) && (mhdr)->smh_ttl > 0) ||     \
345 	((sctp)->sctp_prsctp_aware && ((mhdr)->smh_flags & MSG_PR_SCTP))) && \
346 	((ddi_get_lbolt64() - (mhdr)->smh_tob) > (mhdr)->smh_ttl))
347 
348 /* SCTP association hash function. */
349 #define	SCTP_CONN_HASH(sctps, ports)			\
350 	((((ports) ^ ((ports) >> 16)) * 31) & 		\
351 	    ((sctps)->sctps_conn_hash_size - 1))
352 
353 /*
354  * Bind hash array size and hash function.  The size must be a power
355  * of 2 and lport must be in host byte order.
356  */
357 #define	SCTP_BIND_FANOUT_SIZE	2048
358 #define	SCTP_BIND_HASH(lport)	(((lport) * 31) & (SCTP_BIND_FANOUT_SIZE - 1))
359 
360 /* options that SCTP negotiates during association establishment */
361 #define	SCTP_PRSCTP_OPTION	0x01
362 
363 /*
364  * Listener hash array size and hash function.  The size must be a power
365  * of 2 and lport must be in host byte order.
366  */
367 #define	SCTP_LISTEN_FANOUT_SIZE	512
368 #define	SCTP_LISTEN_HASH(lport) (((lport) * 31) & (SCTP_LISTEN_FANOUT_SIZE - 1))
369 
370 typedef struct sctp_tf_s {
371 	struct sctp_s	*tf_sctp;
372 	kmutex_t	tf_lock;
373 } sctp_tf_t;
374 
375 /* Round up the value to the nearest mss. */
376 #define	MSS_ROUNDUP(value, mss)		((((value) - 1) / (mss) + 1) * (mss))
377 
378 extern sin_t	sctp_sin_null;	/* Zero address for quick clears */
379 extern sin6_t	sctp_sin6_null;	/* Zero address for quick clears */
380 
381 #define	SCTP_IS_DETACHED(sctp)		((sctp)->sctp_detached)
382 
383 /* Data structure used to track received TSNs */
384 typedef struct sctp_set_s {
385 	struct sctp_set_s *next;
386 	struct sctp_set_s *prev;
387 	uint32_t begin;
388 	uint32_t end;
389 } sctp_set_t;
390 
391 /* Data structure used to track TSNs for PR-SCTP */
392 typedef struct sctp_ftsn_set_s {
393 	struct sctp_ftsn_set_s *next;
394 	ftsn_entry_t	ftsn_entries;
395 } sctp_ftsn_set_t;
396 
397 /* Data structure used to track incoming SCTP streams */
398 typedef struct sctp_instr_s {
399 	mblk_t		*istr_msgs;
400 	int		istr_nmsgs;
401 	uint16_t	nextseq;
402 	struct sctp_s	*sctp;
403 	mblk_t		*istr_reass;
404 } sctp_instr_t;
405 
406 /* Reassembly data structure (per-stream) */
407 typedef struct sctp_reass_s {
408 	uint16_t	ssn;
409 	uint16_t	needed;
410 	uint16_t	got;
411 	uint16_t	msglen;		/* len of consecutive fragments */
412 					/* from the begining (B-bit) */
413 	mblk_t		*tail;
414 	boolean_t	hasBchunk;	/* If the fragment list begins with */
415 					/* a B-bit set chunk */
416 	uint32_t	nexttsn;	/* TSN of the next fragment we */
417 					/* are expecting */
418 	boolean_t	partial_delivered;
419 } sctp_reass_t;
420 
421 /* debugging */
422 #undef	dprint
423 #ifdef DEBUG
424 extern int sctpdebug;
425 #define	dprint(level, args)	{ if (sctpdebug > (level)) printf args; }
426 #else
427 #define	dprint(level, args) {}
428 #endif
429 
430 
431 /* Peer address tracking */
432 
433 /*
434  * States for peer addresses
435  *
436  * SCTP_FADDRS_UNCONFIRMED: we have not communicated with this peer address
437  *     before, mark it as unconfirmed so that we will not send data to it.
438  *     All addresses initially are in unconfirmed state and required
439  *     validation.  SCTP sends a heartbeat to each of them and when it gets
440  *     back a heartbeat ACK, the address will be marked as alive.  This
441  *     validation fixes a security issue with multihoming.  If an attacker
442  *     establishes an association with us and tells us that it has addresses
443  *     belonging to another host A, this will prevent A from communicating
444  *     with us.  This is fixed by peer address validation.  In the above case,
445  *     A will respond with an abort.
446  *
447  * SCTP_FADDRS_ALIVE: this peer address is alive and we can communicate with
448  *     it with no problem.
449  *
450  * SCTP_FADDRS_DOWN: we have exceeded the retransmission limit to this
451  *     peer address.  Once an address is marked down, we will only send
452  *     a heartbeat to it every hb_interval in case it becomes alive now.
453  *
454  * SCTP_FADDRS_UNREACH: there is no suitable source address to send to
455  *     this peer address.  For example, the peer address is v6 but we only
456  *     have v4 addresses.  It is marked unreachable until there is an
457  *     address configuration change.  At that time, mark these addresses
458  *     as unconfirmed and try again to see if those unreachable addresses
459  *     are OK as we may have more source addresses.
460  */
461 typedef enum {
462 	SCTP_FADDRS_UNREACH,
463 	SCTP_FADDRS_DOWN,
464 	SCTP_FADDRS_ALIVE,
465 	SCTP_FADDRS_UNCONFIRMED
466 } faddr_state_t;
467 
468 typedef struct sctp_faddr_s {
469 	struct sctp_faddr_s *next;
470 	faddr_state_t	state;
471 
472 	in6_addr_t	faddr;
473 	in6_addr_t	saddr;
474 
475 	int64_t		hb_expiry;	/* time to retransmit heartbeat */
476 	uint32_t	hb_interval;	/* the heartbeat interval */
477 
478 	int		rto;		/* RTO in tick */
479 	int		srtt;		/* Smoothed RTT in tick */
480 	int		rttvar;		/* RTT variance in tick */
481 	uint32_t	rtt_updates;
482 	int		strikes;
483 	int		max_retr;
484 	uint32_t	sfa_pmss;
485 	uint32_t	cwnd;
486 	uint32_t	ssthresh;
487 	uint32_t	suna;		/* sent - unack'ed */
488 	uint32_t	pba;		/* partial bytes acked */
489 	uint32_t	acked;
490 	int64_t		lastactive;
491 	mblk_t		*timer_mp;	/* retransmission timer control */
492 	uint32_t
493 			hb_pending : 1,
494 			timer_running : 1,
495 			df : 1,
496 			pmtu_discovered : 1,
497 
498 			rc_timer_running : 1,
499 			isv4 : 1,
500 			hb_enabled : 1;
501 
502 	mblk_t		*rc_timer_mp;	/* reliable control chunk timer */
503 	ip_xmit_attr_t	*ixa;		/* Transmit attributes */
504 	uint32_t	T3expire;	/* # of times T3 timer expired */
505 
506 	uint64_t	hb_secret;	/* per addr "secret" in heartbeat */
507 	uint32_t	rxt_unacked;	/* # unack'ed retransmitted bytes */
508 } sctp_faddr_t;
509 
510 /* Flags to indicate supported address type in the PARM_SUP_ADDRS. */
511 #define	PARM_SUPP_V6	0x1
512 #define	PARM_SUPP_V4	0x2
513 
514 /*
515  * Set heartbeat interval plus jitter.  The jitter is supposed to be random,
516  * up to +/- 50% of the RTO.  We use gethrtime() here for  performance reason
517  * as the jitter does not really need to be "very" random.
518  */
519 #define	SET_HB_INTVL(fp)					\
520 	((fp)->hb_interval + (fp)->rto + ((fp)->rto >> 1) -	\
521 	(uint_t)gethrtime() % (fp)->rto)
522 
523 #define	SCTP_IPIF_HASH	16
524 
525 typedef	struct	sctp_ipif_hash_s {
526 	list_t		sctp_ipif_list;
527 	int		ipif_count;
528 	krwlock_t	ipif_hash_lock;
529 } sctp_ipif_hash_t;
530 
531 
532 /*
533  * Initialize cwnd according to RFC 3390.  def_max_init_cwnd is
534  * either sctp_slow_start_initial or sctp_slow_start_after idle
535  * depending on the caller.
536  */
537 #define	SET_CWND(fp, mss, def_max_init_cwnd)				\
538 {									\
539 	(fp)->cwnd = MIN(def_max_init_cwnd * (mss),			\
540 	    MIN(4 * (mss), MAX(2 * (mss), 4380 / (mss) * (mss))));	\
541 }
542 
543 
544 struct sctp_s;
545 
546 /*
547  * Control structure for each open SCTP stream,
548  * defined only within the kernel or for a kmem user.
549  * NOTE: sctp_reinit_values MUST have a line for each field in this structure!
550  */
551 #if (defined(_KERNEL) || defined(_KMEMUSER))
552 
553 typedef struct sctp_s {
554 
555 	/*
556 	 * The following is shared with (and duplicated) in IP, so if you
557 	 * make changes, make sure you also change things in ip_sctp.c.
558 	 */
559 	struct sctp_s	*sctp_conn_hash_next;
560 	struct sctp_s	*sctp_conn_hash_prev;
561 
562 	struct sctp_s	*sctp_listen_hash_next;
563 	struct sctp_s	*sctp_listen_hash_prev;
564 
565 	sctp_tf_t	*sctp_listen_tfp;	/* Ptr to tf */
566 	sctp_tf_t	*sctp_conn_tfp;		/* Ptr to tf */
567 
568 	/* Global list of sctp */
569 	list_node_t	sctp_list;
570 
571 	sctp_faddr_t		*sctp_faddrs;
572 	int			sctp_nfaddrs;
573 	sctp_ipif_hash_t	sctp_saddrs[SCTP_IPIF_HASH];
574 	int			sctp_nsaddrs;
575 
576 	kmutex_t	sctp_lock;
577 	kcondvar_t	sctp_cv;
578 	boolean_t	sctp_running;
579 
580 #define	sctp_ulpd	sctp_connp->conn_upper_handle
581 #define	sctp_upcalls	sctp_connp->conn_upcalls
582 
583 #define	sctp_ulp_newconn	sctp_upcalls->su_newconn
584 #define	sctp_ulp_connected	sctp_upcalls->su_connected
585 #define	sctp_ulp_disconnected	sctp_upcalls->su_disconnected
586 #define	sctp_ulp_opctl		sctp_upcalls->su_opctl
587 #define	sctp_ulp_recv		sctp_upcalls->su_recv
588 #define	sctp_ulp_xmitted	sctp_upcalls->su_txq_full
589 #define	sctp_ulp_prop		sctp_upcalls->su_set_proto_props
590 
591 	int32_t		sctp_state;
592 
593 	conn_t		*sctp_connp;		/* conn_t stuff */
594 	sctp_stack_t	*sctp_sctps;
595 
596 	/* Peer address tracking */
597 	sctp_faddr_t	*sctp_lastfaddr;	/* last faddr in list */
598 	sctp_faddr_t	*sctp_primary;		/* primary faddr */
599 	sctp_faddr_t	*sctp_current;		/* current faddr */
600 	sctp_faddr_t	*sctp_lastdata;		/* last data seen from this */
601 
602 	/* Outbound data tracking */
603 	mblk_t		*sctp_xmit_head;
604 	mblk_t		*sctp_xmit_tail;
605 	mblk_t		*sctp_xmit_unsent;
606 	mblk_t		*sctp_xmit_unsent_tail;
607 	mblk_t		*sctp_xmit_unacked;
608 
609 	int32_t		sctp_unacked;		/* # of unacked bytes */
610 	int32_t		sctp_unsent;		/* # of unsent bytes in hand */
611 
612 	uint32_t	sctp_ltsn;		/* Local instance TSN */
613 	uint32_t	sctp_lastack_rxd;	/* Last rx'd cumtsn */
614 	uint32_t	sctp_recovery_tsn;	/* Exit from fast recovery */
615 	uint32_t	sctp_adv_pap;		/* Adv. Peer Ack Point */
616 
617 	uint16_t	sctp_num_ostr;
618 	uint16_t	*sctp_ostrcntrs;
619 
620 	mblk_t		*sctp_pad_mp;		/* pad unaligned data chunks */
621 
622 	/* sendmsg() default parameters */
623 	uint16_t	sctp_def_stream;	/* default stream id */
624 	uint16_t	sctp_def_flags;		/* default xmit flags */
625 	uint32_t	sctp_def_ppid;		/* default payload id */
626 	uint32_t	sctp_def_context;	/* default context */
627 	uint32_t	sctp_def_timetolive;	/* default msg TTL */
628 
629 	/* Inbound data tracking */
630 	sctp_set_t	*sctp_sack_info;	/* Sack tracking */
631 	mblk_t		*sctp_ack_mp;		/* Delayed ACK timer block */
632 	sctp_instr_t	*sctp_instr;		/* Instream trackers */
633 	mblk_t		*sctp_uo_frags;		/* Un-ordered msg. fragments */
634 	uint32_t	sctp_ftsn;		/* Peer's TSN */
635 	uint32_t	sctp_lastacked;		/* last cumtsn SACKd */
636 	uint16_t	sctp_num_istr;		/* No. of instreams */
637 	int32_t		sctp_istr_nmsgs;	/* No. of chunks in instreams */
638 	int32_t		sctp_sack_gaps;		/* No. of received gaps */
639 	int32_t		sctp_sack_toggle;	/* SACK every other pkt */
640 
641 	/* RTT calculation */
642 	uint32_t	sctp_rtt_tsn;
643 	int64_t		sctp_out_time;
644 
645 	/* Stats can be reset by snmp users kstat, netstat and snmp agents */
646 	uint64_t	sctp_opkts;		/* sent pkts */
647 	uint64_t	sctp_obchunks;		/* sent control chunks */
648 	uint64_t	sctp_odchunks;		/* sent ordered data chunks */
649 	uint64_t	sctp_oudchunks;		/* sent unord data chunks */
650 	uint64_t	sctp_rxtchunks;		/* retransmitted chunks */
651 	uint64_t	sctp_ipkts;		/* recv pkts */
652 	uint64_t	sctp_ibchunks;		/* recv control chunks */
653 	uint64_t	sctp_idchunks;		/* recv ordered data chunks */
654 	uint64_t	sctp_iudchunks;		/* recv unord data chunks */
655 	uint64_t	sctp_fragdmsgs;
656 	uint64_t	sctp_reassmsgs;
657 	uint32_t	sctp_T1expire;		/* # of times T1timer expired */
658 	uint32_t	sctp_T2expire;		/* # of times T2timer expired */
659 	uint32_t	sctp_T3expire;		/* # of times T3timer expired */
660 	uint32_t	sctp_assoc_start_time;	/* time when assoc was est. */
661 
662 	uint32_t	sctp_frwnd;		/* Peer RWND */
663 	uint32_t	sctp_cwnd_max;
664 
665 	/* Inbound flow control */
666 	int32_t		sctp_rwnd;		/* Current receive window */
667 	int32_t		sctp_irwnd;		/* Initial receive window */
668 	int32_t		sctp_rxqueued;		/* No. of bytes in RX q's */
669 
670 	/* Pre-initialized composite headers */
671 	uchar_t		*sctp_iphc;	/* v4 sctp/ip hdr template buffer */
672 	uchar_t		*sctp_iphc6;	/* v6 sctp/ip hdr template buffer */
673 
674 	int32_t		sctp_iphc_len;	/* actual allocated v4 buffer size */
675 	int32_t		sctp_iphc6_len;	/* actual allocated v6 buffer size */
676 
677 	int32_t		sctp_hdr_len;	/* len of combined SCTP/IP v4 hdr */
678 	int32_t		sctp_hdr6_len;	/* len of combined SCTP/IP v6 hdr */
679 
680 	ipha_t		*sctp_ipha;	/* IPv4 header in the buffer */
681 	ip6_t		*sctp_ip6h;	/* IPv6 header in the buffer */
682 
683 	int32_t		sctp_ip_hdr_len; /* Byte len of our current v4 hdr */
684 	int32_t		sctp_ip_hdr6_len; /* Byte len of our current v6 hdr */
685 
686 	sctp_hdr_t	*sctp_sctph;	/* sctp header in combined v4 hdr */
687 	sctp_hdr_t	*sctp_sctph6;	/* sctp header in combined v6 hdr */
688 
689 	uint32_t	sctp_lvtag;	/* local SCTP instance verf tag */
690 	uint32_t	sctp_fvtag;	/* Peer's SCTP verf tag */
691 
692 	/* Path MTU Discovery */
693 	int64_t		sctp_last_mtu_probe;
694 	clock_t		sctp_mtu_probe_intvl;
695 	uint32_t	sctp_mss;	/* Max send size (not TCP MSS!) */
696 
697 	/* structs sctp_bits, sctp_events are for clearing all bits at once */
698 	struct {
699 		uint32_t
700 
701 		sctp_understands_asconf : 1, /* Peer handles ASCONF chunks */
702 		sctp_cchunk_pend : 1,	/* Control chunk in flight. */
703 		sctp_lingering : 1,	/* Lingering in close */
704 		sctp_loopback: 1,	/* src and dst are the same machine */
705 
706 		sctp_force_sack : 1,
707 		sctp_ack_timer_running: 1,	/* Delayed ACK timer running */
708 		sctp_hwcksum : 1,	/* The NIC is capable of hwcksum */
709 		sctp_understands_addip : 1,
710 
711 		sctp_bound_to_all : 1,
712 		sctp_cansleep : 1,	/* itf routines can sleep */
713 		sctp_detached : 1,	/* If we're detached from a stream */
714 		sctp_send_adaptation : 1,	/* send adaptation layer ind */
715 
716 		sctp_recv_adaptation : 1,	/* recv adaptation layer ind */
717 		sctp_ndelay : 1,	/* turn off Nagle */
718 		sctp_condemned : 1,	/* this sctp is about to disappear */
719 		sctp_chk_fast_rexmit : 1, /* check for fast rexmit message */
720 
721 		sctp_prsctp_aware : 1,	/* is peer PR-SCTP aware? */
722 		sctp_linklocal : 1,	/* is linklocal assoc. */
723 		sctp_rexmitting : 1,	/* SCTP is retransmitting */
724 		sctp_zero_win_probe : 1,	/* doing zero win probe */
725 
726 		sctp_txq_full : 1,	/* the tx queue is full */
727 		sctp_ulp_discon_done : 1,	/* ulp_disconnecting done */
728 		sctp_dummy : 6;
729 	} sctp_bits;
730 	struct {
731 		uint32_t
732 
733 		sctp_recvsndrcvinfo : 1,
734 		sctp_recvassocevnt : 1,
735 		sctp_recvpathevnt : 1,
736 		sctp_recvsendfailevnt : 1,
737 
738 		sctp_recvpeererr : 1,
739 		sctp_recvshutdownevnt : 1,
740 		sctp_recvpdevnt : 1,
741 		sctp_recvalevnt : 1;
742 	} sctp_events;
743 #define	sctp_priv_stream sctp_bits.sctp_priv_stream
744 #define	sctp_understands_asconf sctp_bits.sctp_understands_asconf
745 #define	sctp_cchunk_pend sctp_bits.sctp_cchunk_pend
746 #define	sctp_lingering sctp_bits.sctp_lingering
747 #define	sctp_loopback sctp_bits.sctp_loopback
748 #define	sctp_force_sack sctp_bits.sctp_force_sack
749 #define	sctp_ack_timer_running sctp_bits.sctp_ack_timer_running
750 #define	sctp_hwcksum sctp_bits.sctp_hwcksum
751 #define	sctp_understands_addip sctp_bits.sctp_understands_addip
752 #define	sctp_bound_to_all sctp_bits.sctp_bound_to_all
753 #define	sctp_cansleep sctp_bits.sctp_cansleep
754 #define	sctp_detached sctp_bits.sctp_detached
755 #define	sctp_send_adaptation sctp_bits.sctp_send_adaptation
756 #define	sctp_recv_adaptation sctp_bits.sctp_recv_adaptation
757 #define	sctp_ndelay sctp_bits.sctp_ndelay
758 #define	sctp_condemned sctp_bits.sctp_condemned
759 #define	sctp_chk_fast_rexmit sctp_bits.sctp_chk_fast_rexmit
760 #define	sctp_prsctp_aware sctp_bits.sctp_prsctp_aware
761 #define	sctp_linklocal sctp_bits.sctp_linklocal
762 #define	sctp_rexmitting sctp_bits.sctp_rexmitting
763 #define	sctp_zero_win_probe sctp_bits.sctp_zero_win_probe
764 #define	sctp_txq_full sctp_bits.sctp_txq_full
765 #define	sctp_ulp_discon_done sctp_bits.sctp_ulp_discon_done
766 
767 #define	sctp_recvsndrcvinfo sctp_events.sctp_recvsndrcvinfo
768 #define	sctp_recvassocevnt sctp_events.sctp_recvassocevnt
769 #define	sctp_recvpathevnt sctp_events.sctp_recvpathevnt
770 #define	sctp_recvsendfailevnt sctp_events.sctp_recvsendfailevnt
771 #define	sctp_recvpeererr sctp_events.sctp_recvpeererr
772 #define	sctp_recvshutdownevnt sctp_events.sctp_recvshutdownevnt
773 #define	sctp_recvpdevnt sctp_events.sctp_recvpdevnt
774 #define	sctp_recvalevnt sctp_events.sctp_recvalevnt
775 
776 	/* Retransmit info */
777 	mblk_t		*sctp_cookie_mp; /* cookie chunk, if rxt needed */
778 	int32_t		sctp_strikes;	/* Total number of assoc strikes */
779 	int32_t		sctp_max_init_rxt;
780 	int32_t		sctp_pa_max_rxt; /* Max per-assoc retransmit cnt */
781 	int32_t		sctp_pp_max_rxt; /* Max per-path retransmit cnt */
782 	uint32_t	sctp_rto_max;
783 	uint32_t	sctp_init_rto_max;
784 	uint32_t	sctp_rto_min;
785 	uint32_t	sctp_rto_initial;
786 
787 	int64_t		sctp_last_secret_update;
788 	uint8_t		sctp_secret[SCTP_SECRET_LEN]; /* for cookie auth */
789 	uint8_t		sctp_old_secret[SCTP_SECRET_LEN];
790 	uint32_t	sctp_cookie_lifetime;	/* cookie lifetime in tick */
791 
792 	/* Bind hash tables */
793 	kmutex_t	*sctp_bind_lockp;	/* Ptr to tf_lock */
794 	struct sctp_s	*sctp_bind_hash;
795 	struct sctp_s **sctp_ptpbhn;
796 
797 	/* Shutdown / cleanup */
798 	sctp_faddr_t	*sctp_shutdown_faddr;	/* rotate faddr during shutd */
799 	int32_t		sctp_client_errno;	/* How the client screwed up */
800 	kmutex_t	sctp_reflock;	/* Protects sctp_refcnt & timer mp */
801 	ushort_t	sctp_refcnt;	/* No. of pending upstream msg */
802 	mblk_t		*sctp_timer_mp;	/* List of fired timers. */
803 
804 	mblk_t		*sctp_heartbeat_mp; /* Timer block for heartbeats */
805 	uint32_t	sctp_hb_interval; /* Default hb_interval */
806 
807 	int32_t		sctp_autoclose;	/* Auto disconnect in ticks */
808 	int64_t		sctp_active;	/* Last time data/sack on this conn */
809 	uint32_t	sctp_tx_adaptation_code; /* TX adaptation code */
810 	uint32_t	sctp_rx_adaptation_code; /* RX adaptation code */
811 
812 	/* Reliable control chunks */
813 	mblk_t		*sctp_cxmit_list; /* Xmit list for control chunks */
814 	uint32_t	sctp_lcsn;	/* Our serial number */
815 	uint32_t	sctp_fcsn;	/* Peer serial number */
816 
817 	/* Per association receive queue */
818 	kmutex_t	sctp_recvq_lock;
819 	mblk_t		*sctp_recvq;
820 	mblk_t		*sctp_recvq_tail;
821 	taskq_t		*sctp_recvq_tq;
822 
823 	/* IPv6 ancillary data */
824 	uint_t		sctp_recvifindex;	/* last rcvd IPV6_RCVPKTINFO */
825 	uint_t		sctp_recvhops;		/*  " IPV6_RECVHOPLIMIT */
826 	uint_t		sctp_recvtclass;	/*  " IPV6_RECVTCLASS */
827 	ip6_hbh_t	*sctp_hopopts;		/*  " IPV6_RECVHOPOPTS */
828 	ip6_dest_t	*sctp_dstopts;		/*  " IPV6_RECVDSTOPTS */
829 	ip6_dest_t	*sctp_rthdrdstopts;	/*  " IPV6_RECVRTHDRDSTOPTS */
830 	ip6_rthdr_t	*sctp_rthdr;		/*  " IPV6_RECVRTHDR */
831 	uint_t		sctp_hopoptslen;
832 	uint_t		sctp_dstoptslen;
833 	uint_t		sctp_rthdrdstoptslen;
834 	uint_t		sctp_rthdrlen;
835 
836 	/* Stats */
837 	uint64_t	sctp_msgcount;
838 	uint64_t	sctp_prsctpdrop;
839 
840 	uint_t		sctp_v4label_len;	/* length of cached v4 label */
841 	uint_t		sctp_v6label_len;	/* length of cached v6 label */
842 	uint32_t	sctp_rxt_nxttsn;	/* Next TSN to be rexmitted */
843 	uint32_t	sctp_rxt_maxtsn;	/* Max TSN sent at time out */
844 
845 	int		sctp_pd_point;		/* Partial delivery point */
846 	mblk_t		*sctp_err_chunks;	/* Error chunks */
847 	uint32_t	sctp_err_len;		/* Total error chunks length */
848 
849 	/* additional source data for per endpoint association statistics */
850 	uint64_t	sctp_outseqtsns;	/* TSN rx > expected TSN */
851 	uint64_t	sctp_osacks;		/* total sacks sent */
852 	uint64_t	sctp_isacks;		/* total sacks received */
853 	uint64_t	sctp_idupchunks;	/* rx dups, ord or unord */
854 	uint64_t	sctp_gapcnt;		/* total gap acks rx */
855 	/*
856 	 * Add the current data from the counters which are reset by snmp
857 	 * to these cumulative counters to use in per endpoint statistics.
858 	 */
859 	uint64_t	sctp_cum_obchunks;	/* sent control chunks */
860 	uint64_t	sctp_cum_odchunks;	/* sent ordered data chunks */
861 	uint64_t	sctp_cum_oudchunks;	/* sent unord data chunks */
862 	uint64_t	sctp_cum_rxtchunks;	/* retransmitted chunks */
863 	uint64_t	sctp_cum_ibchunks;	/* recv control chunks */
864 	uint64_t	sctp_cum_idchunks;	/* recv ordered data chunks */
865 	uint64_t	sctp_cum_iudchunks;	/* recv unord data chunks */
866 
867 	/*
868 	 * When non-zero, this is the maximum observed RTO since assoc stats
869 	 * were last requested. When zero, no RTO update has occurred since
870 	 * the previous user request for stats on this endpoint.
871 	 */
872 	int	sctp_maxrto;
873 	/*
874 	 * The stored value of sctp_maxrto passed to user during the previous
875 	 * user request for stats on this endpoint.
876 	 */
877 	int	sctp_prev_maxrto;
878 } sctp_t;
879 
880 #define	SCTP_TXQ_LEN(sctp)	((sctp)->sctp_unsent + (sctp)->sctp_unacked)
881 #define	SCTP_TXQ_UPDATE(sctp)					\
882 	if ((sctp)->sctp_txq_full && SCTP_TXQ_LEN(sctp) <=	\
883 	    (sctp)->sctp_connp->conn_sndlowat) {		\
884 		(sctp)->sctp_txq_full = 0;			\
885 		(sctp)->sctp_ulp_xmitted((sctp)->sctp_ulpd,	\
886 		    B_FALSE);					\
887 	}
888 
889 #endif	/* (defined(_KERNEL) || defined(_KMEMUSER)) */
890 
891 extern void	sctp_ack_timer(sctp_t *);
892 extern size_t	sctp_adaptation_code_param(sctp_t *, uchar_t *);
893 extern void	sctp_adaptation_event(sctp_t *);
894 extern void	sctp_add_err(sctp_t *, uint16_t, void *, size_t,
895 		    sctp_faddr_t *);
896 extern int	sctp_add_faddr(sctp_t *, in6_addr_t *, int, boolean_t);
897 extern boolean_t sctp_add_ftsn_set(sctp_ftsn_set_t **, sctp_faddr_t *, mblk_t *,
898 		    uint_t *, uint32_t *);
899 extern void	sctp_add_recvq(sctp_t *, mblk_t *, boolean_t,
900 		    ip_recv_attr_t *);
901 extern void	sctp_add_unrec_parm(sctp_parm_hdr_t *, mblk_t **, boolean_t);
902 extern size_t	sctp_addr_params(sctp_t *, int, uchar_t *, boolean_t);
903 extern mblk_t	*sctp_add_proto_hdr(sctp_t *, sctp_faddr_t *, mblk_t *, int,
904 		    int *);
905 extern void	sctp_addr_req(sctp_t *, mblk_t *);
906 extern sctp_t	*sctp_addrlist2sctp(mblk_t *, sctp_hdr_t *, sctp_chunk_hdr_t *,
907 		    zoneid_t, sctp_stack_t *);
908 extern void	sctp_check_adv_ack_pt(sctp_t *, mblk_t *, mblk_t *);
909 extern void	sctp_assoc_event(sctp_t *, uint16_t, uint16_t,
910 		    sctp_chunk_hdr_t *);
911 
912 extern void	sctp_bind_hash_insert(sctp_tf_t *, sctp_t *, int);
913 extern void	sctp_bind_hash_remove(sctp_t *);
914 extern int	sctp_bindi(sctp_t *, in_port_t, boolean_t, int, in_port_t *);
915 extern int	sctp_bind_add(sctp_t *, const void *, uint32_t, boolean_t,
916 		    in_port_t);
917 extern int	sctp_bind_del(sctp_t *, const void *, uint32_t, boolean_t);
918 extern int	sctp_build_hdrs(sctp_t *, int);
919 
920 extern int	sctp_check_abandoned_msg(sctp_t *, mblk_t *);
921 extern void	sctp_clean_death(sctp_t *, int);
922 extern void	sctp_close_eager(sctp_t *);
923 extern int	sctp_compare_faddrsets(sctp_faddr_t *, sctp_faddr_t *);
924 extern void	sctp_congest_reset(sctp_t *);
925 extern void	sctp_conn_hash_insert(sctp_tf_t *, sctp_t *, int);
926 extern void	sctp_conn_hash_remove(sctp_t *);
927 extern void	sctp_conn_init(conn_t *);
928 extern sctp_t	*sctp_conn_match(in6_addr_t *, in6_addr_t *, uint32_t,
929 		    zoneid_t, iaflags_t, sctp_stack_t *);
930 extern sctp_t	*sctp_conn_request(sctp_t *, mblk_t *, uint_t, uint_t,
931 		    sctp_init_chunk_t *, ip_recv_attr_t *);
932 extern uint32_t	sctp_cumack(sctp_t *, uint32_t, mblk_t **);
933 extern sctp_t	*sctp_create_eager(sctp_t *);
934 
935 extern void	sctp_dispatch_rput(queue_t *, sctp_t *, sctp_hdr_t *, mblk_t *,
936 		    uint_t, uint_t, in6_addr_t);
937 extern char	*sctp_display(sctp_t *, char *);
938 extern void	sctp_display_all(sctp_stack_t *);
939 
940 extern void	sctp_error_event(sctp_t *, sctp_chunk_hdr_t *, boolean_t);
941 
942 extern void	sctp_faddr_alive(sctp_t *, sctp_faddr_t *);
943 extern int	sctp_faddr_dead(sctp_t *, sctp_faddr_t *, int);
944 extern void	sctp_faddr_fini(void);
945 extern void	sctp_faddr_init(void);
946 extern void	sctp_fast_rexmit(sctp_t *);
947 extern void	sctp_fill_sack(sctp_t *, unsigned char *, int);
948 extern void	sctp_free_faddr_timers(sctp_t *);
949 extern void	sctp_free_ftsn_set(sctp_ftsn_set_t *);
950 extern void	sctp_free_msg(mblk_t *);
951 extern void	sctp_free_reass(sctp_instr_t *);
952 extern void	sctp_free_set(sctp_set_t *);
953 extern void	sctp_ftsn_sets_fini(void);
954 extern void	sctp_ftsn_sets_init(void);
955 
956 extern int	sctp_get_addrlist(sctp_t *, const void *, uint32_t *,
957 		    uchar_t **, int *, size_t *);
958 extern int	sctp_get_addrparams(sctp_t *, sctp_t *, mblk_t *,
959 		    sctp_chunk_hdr_t *, uint_t *);
960 extern void	sctp_get_dest(sctp_t *, sctp_faddr_t *);
961 extern void	sctp_get_faddr_list(sctp_t *, uchar_t *, size_t);
962 extern mblk_t	*sctp_get_first_sent(sctp_t *);
963 extern mblk_t	*sctp_get_msg_to_send(sctp_t *, mblk_t **, mblk_t *, int  *,
964 		    int32_t, uint32_t, sctp_faddr_t *);
965 extern void	sctp_get_saddr_list(sctp_t *, uchar_t *, size_t);
966 
967 extern int	sctp_handle_error(sctp_t *, sctp_hdr_t *, sctp_chunk_hdr_t *,
968 		    mblk_t *, ip_recv_attr_t *);
969 extern void	sctp_hash_destroy(sctp_stack_t *);
970 extern void	sctp_hash_init(sctp_stack_t *);
971 extern void	sctp_heartbeat_timer(sctp_t *);
972 
973 extern void	sctp_icmp_error(sctp_t *, mblk_t *);
974 extern void	sctp_inc_taskq(sctp_stack_t *);
975 extern void	sctp_info_req(sctp_t *, mblk_t *);
976 extern mblk_t	*sctp_init_mp(sctp_t *, sctp_faddr_t *);
977 extern boolean_t sctp_initialize_params(sctp_t *, sctp_init_chunk_t *,
978 		    sctp_init_chunk_t *);
979 extern uint32_t	sctp_init2vtag(sctp_chunk_hdr_t *);
980 extern void	sctp_intf_event(sctp_t *, in6_addr_t, int, int);
981 extern void	sctp_input_data(sctp_t *, mblk_t *, ip_recv_attr_t *);
982 extern void	sctp_instream_cleanup(sctp_t *, boolean_t);
983 extern int	sctp_is_a_faddr_clean(sctp_t *);
984 
985 extern void	*sctp_kstat_init(netstackid_t);
986 extern void	sctp_kstat_fini(netstackid_t, kstat_t *);
987 extern void	*sctp_kstat2_init(netstackid_t, sctp_kstat_t *);
988 extern void	sctp_kstat2_fini(netstackid_t, kstat_t *);
989 
990 extern ssize_t	sctp_link_abort(mblk_t *, uint16_t, char *, size_t, int,
991 		    boolean_t);
992 extern void	sctp_listen_hash_insert(sctp_tf_t *, sctp_t *);
993 extern void	sctp_listen_hash_remove(sctp_t *);
994 extern sctp_t	*sctp_lookup(sctp_t *, in6_addr_t *, sctp_tf_t *, uint32_t *,
995 		    int);
996 extern sctp_faddr_t *sctp_lookup_faddr(sctp_t *, in6_addr_t *);
997 
998 extern mblk_t	*sctp_make_err(sctp_t *, uint16_t, void *, size_t);
999 extern mblk_t	*sctp_make_ftsn_chunk(sctp_t *, sctp_faddr_t *,
1000 		    sctp_ftsn_set_t *, uint_t, uint32_t);
1001 extern void	sctp_make_ftsns(sctp_t *, mblk_t *, mblk_t *, mblk_t **,
1002 		    sctp_faddr_t *, uint32_t *);
1003 extern mblk_t	*sctp_make_mp(sctp_t *, sctp_faddr_t *, int);
1004 extern mblk_t	*sctp_make_sack(sctp_t *, sctp_faddr_t *, mblk_t *);
1005 extern void	sctp_maxpsz_set(sctp_t *);
1006 extern void	sctp_move_faddr_timers(queue_t *, sctp_t *);
1007 
1008 extern void	sctp_nd_free(sctp_stack_t *);
1009 extern int	sctp_nd_getset(queue_t *, MBLKP);
1010 extern boolean_t sctp_nd_init(sctp_stack_t *);
1011 extern sctp_parm_hdr_t *sctp_next_parm(sctp_parm_hdr_t *, ssize_t *);
1012 
1013 extern void	sctp_ootb_shutdown_ack(mblk_t *, uint_t, ip_recv_attr_t *,
1014 		    ip_stack_t *);
1015 extern size_t	sctp_options_param(const sctp_t *, void *, int);
1016 extern size_t	sctp_options_param_len(const sctp_t *, int);
1017 extern void	sctp_output(sctp_t *, uint_t);
1018 
1019 extern boolean_t sctp_param_register(IDP *, sctpparam_t *, int, sctp_stack_t *);
1020 extern void	sctp_partial_delivery_event(sctp_t *);
1021 extern int	sctp_process_cookie(sctp_t *, sctp_chunk_hdr_t *, mblk_t *,
1022 		    sctp_init_chunk_t **, sctp_hdr_t *, int *, in6_addr_t *,
1023 		    ip_recv_attr_t *);
1024 extern void	sctp_process_err(sctp_t *);
1025 extern void	sctp_process_heartbeat(sctp_t *, sctp_chunk_hdr_t *);
1026 extern void	sctp_process_timer(sctp_t *);
1027 
1028 extern void	sctp_redo_faddr_srcs(sctp_t *);
1029 extern void	sctp_regift_xmitlist(sctp_t *);
1030 extern void	sctp_return_heartbeat(sctp_t *, sctp_chunk_hdr_t *, mblk_t *);
1031 extern void	sctp_rexmit(sctp_t *, sctp_faddr_t *);
1032 extern mblk_t	*sctp_rexmit_packet(sctp_t *, mblk_t **, mblk_t **,
1033 		    sctp_faddr_t *, uint_t *);
1034 extern void	sctp_rexmit_timer(sctp_t *, sctp_faddr_t *);
1035 extern sctp_faddr_t *sctp_rotate_faddr(sctp_t *, sctp_faddr_t *);
1036 
1037 extern boolean_t sctp_sack(sctp_t *, mblk_t *);
1038 extern int	sctp_secure_restart_check(mblk_t *, sctp_chunk_hdr_t *,
1039 		    uint32_t, int, sctp_stack_t *, ip_recv_attr_t *);
1040 extern void	sctp_send_abort(sctp_t *, uint32_t, uint16_t, char *, size_t,
1041 		    mblk_t *, int, boolean_t, ip_recv_attr_t *);
1042 extern void	sctp_ootb_send_abort(uint32_t, uint16_t, char *, size_t,
1043 		    const mblk_t *, int, boolean_t, ip_recv_attr_t *,
1044 		    ip_stack_t *);
1045 extern void	sctp_send_cookie_ack(sctp_t *);
1046 extern void	sctp_send_cookie_echo(sctp_t *, sctp_chunk_hdr_t *, mblk_t *,
1047 			ip_recv_attr_t *);
1048 extern void	sctp_send_initack(sctp_t *, sctp_hdr_t *, sctp_chunk_hdr_t *,
1049 		    mblk_t *, ip_recv_attr_t *);
1050 extern void	sctp_send_shutdown(sctp_t *, int);
1051 extern void	sctp_send_heartbeat(sctp_t *, sctp_faddr_t *);
1052 extern void	sctp_sendfail_event(sctp_t *, mblk_t *, int, boolean_t);
1053 extern void	sctp_set_faddr_current(sctp_t *, sctp_faddr_t *);
1054 extern int	sctp_set_hdraddrs(sctp_t *);
1055 extern void	sctp_set_saddr(sctp_t *, sctp_faddr_t *);
1056 extern void	sctp_sets_init(void);
1057 extern void	sctp_sets_fini(void);
1058 extern void	sctp_shutdown_event(sctp_t *);
1059 extern void	sctp_stop_faddr_timers(sctp_t *);
1060 extern int	sctp_shutdown_received(sctp_t *, sctp_chunk_hdr_t *, boolean_t,
1061 		    boolean_t, sctp_faddr_t *);
1062 extern void	sctp_shutdown_complete(sctp_t *);
1063 extern void	sctp_set_if_mtu(sctp_t *);
1064 extern void	sctp_set_iplen(sctp_t *, mblk_t *, ip_xmit_attr_t *);
1065 extern void	sctp_set_ulp_prop(sctp_t *);
1066 extern void	sctp_ss_rexmit(sctp_t *);
1067 extern size_t	sctp_supaddr_param_len(sctp_t *);
1068 extern size_t	sctp_supaddr_param(sctp_t *, uchar_t *);
1069 
1070 extern void	sctp_timer(sctp_t *, mblk_t *, clock_t);
1071 extern mblk_t	*sctp_timer_alloc(sctp_t *, pfv_t, int);
1072 extern void	sctp_timer_call(sctp_t *sctp, mblk_t *);
1073 extern void	sctp_timer_free(mblk_t *);
1074 extern void	sctp_timer_stop(mblk_t *);
1075 extern void	sctp_unlink_faddr(sctp_t *, sctp_faddr_t *);
1076 
1077 extern void	sctp_update_dce(sctp_t *sctp);
1078 extern in_port_t sctp_update_next_port(in_port_t, zone_t *zone, sctp_stack_t *);
1079 extern void	sctp_update_rtt(sctp_t *, sctp_faddr_t *, clock_t);
1080 extern void	sctp_user_abort(sctp_t *, mblk_t *);
1081 
1082 extern void	sctp_validate_peer(sctp_t *);
1083 
1084 extern void	sctp_wput_ioctl(queue_t *, mblk_t *);
1085 
1086 extern int	sctp_xmit_list_clean(sctp_t *, ssize_t);
1087 
1088 extern void	sctp_zap_addrs(sctp_t *);
1089 extern void	sctp_zap_faddrs(sctp_t *, int);
1090 
1091 /* Contract private interface between SCTP and Clustering - PSARC/2005/602 */
1092 
1093 extern void	(*cl_sctp_listen)(sa_family_t, uchar_t *, uint_t, in_port_t);
1094 extern void	(*cl_sctp_unlisten)(sa_family_t, uchar_t *, uint_t, in_port_t);
1095 extern void 	(*cl_sctp_connect)(sa_family_t, uchar_t *, uint_t, in_port_t,
1096 		    uchar_t *, uint_t, in_port_t, boolean_t, cl_sctp_handle_t);
1097 extern void	(*cl_sctp_disconnect)(sa_family_t, cl_sctp_handle_t);
1098 extern void	(*cl_sctp_assoc_change)(sa_family_t, uchar_t *, size_t, uint_t,
1099 		    uchar_t *, size_t, uint_t, int, cl_sctp_handle_t);
1100 extern void	(*cl_sctp_check_addrs)(sa_family_t, in_port_t, uchar_t **,
1101 		    size_t, uint_t *, boolean_t);
1102 
1103 #define	RUN_SCTP(sctp)						\
1104 {								\
1105 	mutex_enter(&(sctp)->sctp_lock);			\
1106 	while ((sctp)->sctp_running)				\
1107 		cv_wait(&(sctp)->sctp_cv, &(sctp)->sctp_lock);	\
1108 	(sctp)->sctp_running = B_TRUE;				\
1109 	mutex_exit(&(sctp)->sctp_lock);				\
1110 }
1111 
1112 /* Wake up recvq taskq */
1113 #define	WAKE_SCTP(sctp)				\
1114 {						\
1115 	mutex_enter(&(sctp)->sctp_lock);	\
1116 	if ((sctp)->sctp_timer_mp != NULL)	\
1117 		sctp_process_timer(sctp);	\
1118 	(sctp)->sctp_running = B_FALSE;		\
1119 	cv_broadcast(&(sctp)->sctp_cv);		\
1120 	mutex_exit(&(sctp)->sctp_lock);		\
1121 }
1122 
1123 #ifdef	__cplusplus
1124 }
1125 #endif
1126 
1127 #endif	/* _INET_SCTP_SCTP_IMPL_H */
1128