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