xref: /titanic_41/usr/src/uts/common/inet/sctp/sctp_impl.h (revision 9b214d32697277d03ed2e5d98c4a7bfef16dcf4d)
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 2009 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 #define	SCTP_CALC_RXT(fp, max)		\
171 {					\
172 	if (((fp)->rto <<= 1) > (max))	\
173 		(fp)->rto = (max);	\
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 	ASSERT((sctp)->sctp_refcnt != 0);	\
187 	mutex_exit(&(sctp)->sctp_reflock);	\
188 }
189 
190 #define	SCTP_REFRELE(sctp) {				\
191 	mutex_enter(&(sctp)->sctp_reflock);		\
192 	ASSERT((sctp)->sctp_refcnt != 0);		\
193 	if (--(sctp)->sctp_refcnt == 0) {		\
194 		mutex_exit(&(sctp)->sctp_reflock);	\
195 		CONN_DEC_REF((sctp)->sctp_connp);	\
196 	} else {					\
197 		mutex_exit(&(sctp)->sctp_reflock);	\
198 	}						\
199 }
200 
201 #define	SCTP_G_Q_REFHOLD(sctps) {					\
202 	atomic_add_32(&(sctps)->sctps_g_q_ref, 1);			\
203 	ASSERT((sctps)->sctps_g_q_ref != 0);				\
204 	DTRACE_PROBE1(sctp__g__q__refhold, sctp_stack_t, sctps);	\
205 }
206 
207 /*
208  * Decrement the reference count on sctp_g_q
209  * In architectures e.g sun4u, where atomic_add_32_nv is just
210  * a cas, we need to maintain the right memory barrier semantics
211  * as that of mutex_exit i.e all the loads and stores should complete
212  * before the cas is executed. membar_exit() does that here.
213  */
214 #define	SCTP_G_Q_REFRELE(sctps) {					\
215 	ASSERT((sctps)->sctps_g_q_ref != 0);				\
216 	membar_exit();							\
217 	DTRACE_PROBE1(sctp__g__q__refrele, sctp_stack_t, sctps);	\
218 	if (atomic_add_32_nv(&(sctps)->sctps_g_q_ref, -1) == 0)		\
219 		sctp_g_q_inactive(sctps);				\
220 }
221 
222 #define	SCTP_PRINTADDR(a)	(a).s6_addr32[0], (a).s6_addr32[1],\
223 				(a).s6_addr32[2], (a).s6_addr32[3]
224 
225 #define	CONN2SCTP(conn)	((sctp_t *)(&((conn_t *)conn)[1]))
226 
227 /*
228  * Outbound data, flags and macros for per-message, per-chunk info
229  */
230 typedef struct {
231 	int64_t		smh_ttl;		/* Time to Live */
232 	int64_t		smh_tob;		/* Time of Birth */
233 	uint32_t	smh_context;
234 	uint16_t	smh_sid;
235 	uint16_t	smh_ssn;
236 	uint32_t	smh_ppid;
237 	uint16_t	smh_flags;
238 	uint32_t	smh_msglen;
239 } sctp_msg_hdr_t;
240 
241 #define	SCTP_CHUNK_FLAG_SENT		0x01
242 #define	SCTP_CHUNK_FLAG_REXMIT		0x02
243 #define	SCTP_CHUNK_FLAG_ACKED		0x04
244 #define	SCTP_MSG_FLAG_CHUNKED		0x08
245 #define	SCTP_MSG_FLAG_ABANDONED		0x10
246 #define	SCTP_CHUNK_FLAG_ABANDONED	0x20
247 
248 #define	SCTP_CHUNK_CLEAR_FLAGS(mp) ((mp)->b_flag = 0)
249 /*
250  * If we are transmitting the chunk for the first time we assign the TSN and
251  * SSN here. The reason we assign the SSN here (as opposed to doing it in
252  * sctp_chunkify()) is that the chunk may expire, if PRSCTP is enabled, before
253  * we get a chance to send it out. If we assign the SSN in sctp_chunkify()
254  * and this happens, then we need to send a Forward TSN to the peer, which
255  * will be expecting this SSN, assuming ordered. If we assign it here we
256  * can just take out the chunk from the transmit list without having to
257  * send a Forward TSN chunk. While assigning the SSN we use (meta)->b_cont
258  * to determine if it needs a new SSN (i.e. the next SSN for the stream),
259  * since (meta)->b_cont signifies the first chunk of a message (if the message
260  * is unordered, then the SSN is 0).
261  *
262  */
263 #define	SCTP_CHUNK_SENT(sctp, mp, sdc, fp, chunkdata, meta) {		\
264 	if (!SCTP_CHUNK_ISSENT(mp)) {					\
265 		sctp_msg_hdr_t	*mhdr = (sctp_msg_hdr_t *)(meta)->b_rptr; \
266 		ASSERT(!SCTP_CHUNK_ABANDONED(mp));			\
267 		(mp)->b_flag = SCTP_CHUNK_FLAG_SENT;			\
268 		(sdc)->sdh_tsn = htonl((sctp)->sctp_ltsn++);		\
269 		if ((mhdr)->smh_flags & MSG_UNORDERED) {		\
270 			(sdc)->sdh_ssn = 0;				\
271 			SCTP_DATA_SET_UBIT(sdc);			\
272 			BUMP_LOCAL((sctp)->sctp_oudchunks);		\
273 		} else {						\
274 			BUMP_LOCAL((sctp)->sctp_odchunks);		\
275 			if ((mp) == (meta)->b_cont) {			\
276 				mhdr->smh_ssn = htons(			\
277 				    (sctp)->sctp_ostrcntrs[mhdr->smh_sid]++); \
278 			}						\
279 			(sdc)->sdh_ssn = mhdr->smh_ssn;			\
280 		}							\
281 		(sctp)->sctp_unacked += (chunkdata);			\
282 		(sctp)->sctp_unsent -= (chunkdata);			\
283 		(sctp)->sctp_frwnd -= (chunkdata);			\
284 	} else {							\
285 		if (SCTP_CHUNK_ISACKED(mp)) {				\
286 			(sctp)->sctp_unacked += (chunkdata);		\
287 		} else {						\
288 			ASSERT(SCTP_CHUNK_DEST(mp)->suna >= ((chunkdata) + \
289 							sizeof (*sdc))); \
290 			SCTP_CHUNK_DEST(mp)->suna -= ((chunkdata) + 	\
291 					sizeof (*sdc));			\
292 		}							\
293 		(mp)->b_flag &= ~(SCTP_CHUNK_FLAG_REXMIT |		\
294 			SCTP_CHUNK_FLAG_ACKED);				\
295 		SCTP_CHUNK_SET_SACKCNT(mp, 0);				\
296 		BUMP_LOCAL(sctp->sctp_rxtchunks);			\
297 		BUMP_LOCAL((sctp)->sctp_T3expire);			\
298 		BUMP_LOCAL((fp)->T3expire);				\
299 	}								\
300 	SCTP_SET_CHUNK_DEST(mp, fp);					\
301 	(fp)->suna += ((chunkdata) + sizeof (*sdc));			\
302 }
303 
304 #define	SCTP_CHUNK_ISSENT(mp)	((mp)->b_flag & SCTP_CHUNK_FLAG_SENT)
305 #define	SCTP_CHUNK_CANSEND(mp)	\
306 	(!(SCTP_CHUNK_ABANDONED(mp)) &&	\
307 	(((mp)->b_flag & (SCTP_CHUNK_FLAG_REXMIT|SCTP_CHUNK_FLAG_SENT)) != \
308 	SCTP_CHUNK_FLAG_SENT))
309 
310 #define	SCTP_CHUNK_DEST(mp)		((sctp_faddr_t *)(mp)->b_queue)
311 #define	SCTP_SET_CHUNK_DEST(mp, fp)	((mp)->b_queue = (queue_t *)fp)
312 
313 #define	SCTP_CHUNK_REXMIT(mp)	((mp)->b_flag |= SCTP_CHUNK_FLAG_REXMIT)
314 #define	SCTP_CHUNK_CLEAR_REXMIT(mp) ((mp)->b_flag &= ~SCTP_CHUNK_FLAG_REXMIT)
315 #define	SCTP_CHUNK_WANT_REXMIT(mp) ((mp)->b_flag & SCTP_CHUNK_FLAG_REXMIT)
316 
317 #define	SCTP_CHUNK_ACKED(mp) \
318 	((mp)->b_flag = (SCTP_CHUNK_FLAG_SENT|SCTP_CHUNK_FLAG_ACKED))
319 #define	SCTP_CHUNK_ISACKED(mp)	((mp)->b_flag & SCTP_CHUNK_FLAG_ACKED)
320 #define	SCTP_CHUNK_CLEAR_ACKED(mp) ((mp)->b_flag &= ~SCTP_CHUNK_FLAG_ACKED)
321 
322 #define	SCTP_CHUNK_SACKCNT(mp)	((intptr_t)((mp)->b_prev))
323 #define	SCTP_CHUNK_SET_SACKCNT(mp, val) ((mp)->b_prev = \
324 					(mblk_t *)(uintptr_t)(val))
325 
326 #define	SCTP_MSG_SET_CHUNKED(mp)	((mp)->b_flag |= SCTP_MSG_FLAG_CHUNKED)
327 #define	SCTP_MSG_CLEAR_CHUNKED(mp)((mp)->b_flag &= ~SCTP_MSG_FLAG_CHUNKED)
328 #define	SCTP_IS_MSG_CHUNKED(mp)	((mp)->b_flag & SCTP_MSG_FLAG_CHUNKED)
329 
330 /* For PR-SCTP */
331 #define	SCTP_ABANDON_CHUNK(mp)	((mp)->b_flag |= SCTP_CHUNK_FLAG_ABANDONED)
332 #define	SCTP_CHUNK_ABANDONED(mp) \
333 	((mp)->b_flag & SCTP_CHUNK_FLAG_ABANDONED)
334 
335 #define	SCTP_MSG_SET_ABANDONED(mp)	\
336 	((mp)->b_flag |= SCTP_MSG_FLAG_ABANDONED)
337 #define	SCTP_MSG_CLEAR_ABANDONED(mp)((mp)->b_flag &= ~SCTP_MSG_FLAG_ABANDONED)
338 #define	SCTP_IS_MSG_ABANDONED(mp)	((mp)->b_flag & SCTP_MSG_FLAG_ABANDONED)
339 
340 /*
341  * Check if a message has expired.  A message is expired if
342  *	1. It has a non-zero time to live value and has not been sent before
343  *	that time expires.
344  *	2. It is sent using PRSCTP and it has not been SACK'ed before
345  *	its lifetime expires.
346  */
347 #define	SCTP_MSG_TO_BE_ABANDONED(meta, mhdr, sctp)			     \
348 	(((!SCTP_CHUNK_ISSENT((meta)->b_cont) && (mhdr)->smh_ttl > 0) ||     \
349 	((sctp)->sctp_prsctp_aware && ((mhdr)->smh_flags & MSG_PR_SCTP))) && \
350 	((lbolt64 - (mhdr)->smh_tob) > (mhdr)->smh_ttl))
351 
352 /* SCTP association hash function. */
353 #define	SCTP_CONN_HASH(sctps, ports)			\
354 	((((ports) ^ ((ports) >> 16)) * 31) & 		\
355 	    ((sctps)->sctps_conn_hash_size - 1))
356 
357 /*
358  * Bind hash array size and hash function.  The size must be a power
359  * of 2 and lport must be in host byte order.
360  */
361 #define	SCTP_BIND_FANOUT_SIZE	2048
362 #define	SCTP_BIND_HASH(lport)	(((lport) * 31) & (SCTP_BIND_FANOUT_SIZE - 1))
363 
364 /* options that SCTP negotiates during association establishment */
365 #define	SCTP_PRSCTP_OPTION	0x01
366 
367 /*
368  * Listener hash array size and hash function.  The size must be a power
369  * of 2 and lport must be in host byte order.
370  */
371 #define	SCTP_LISTEN_FANOUT_SIZE	512
372 #define	SCTP_LISTEN_HASH(lport) (((lport) * 31) & (SCTP_LISTEN_FANOUT_SIZE - 1))
373 
374 typedef struct sctp_tf_s {
375 	struct sctp_s	*tf_sctp;
376 	kmutex_t	tf_lock;
377 } sctp_tf_t;
378 
379 /* Round up the value to the nearest mss. */
380 #define	MSS_ROUNDUP(value, mss)		((((value) - 1) / (mss) + 1) * (mss))
381 
382 extern sin_t	sctp_sin_null;	/* Zero address for quick clears */
383 extern sin6_t	sctp_sin6_null;	/* Zero address for quick clears */
384 
385 #define	SCTP_IS_DETACHED(sctp)		((sctp)->sctp_detached)
386 
387 /*
388  * Object to represent database of options to search passed to
389  * {sock,tpi}optcom_req() interface routine to take care of option
390  * management and associated methods.
391  * XXX These and other externs should ideally move to a SCTP header
392  */
393 extern optdb_obj_t	sctp_opt_obj;
394 extern uint_t		sctp_max_optbuf_len;
395 
396 /* Data structure used to track received TSNs */
397 typedef struct sctp_set_s {
398 	struct sctp_set_s *next;
399 	struct sctp_set_s *prev;
400 	uint32_t begin;
401 	uint32_t end;
402 } sctp_set_t;
403 
404 /* Data structure used to track TSNs for PR-SCTP */
405 typedef struct sctp_ftsn_set_s {
406 	struct sctp_ftsn_set_s *next;
407 	ftsn_entry_t	ftsn_entries;
408 } sctp_ftsn_set_t;
409 
410 /* Data structure used to track incoming SCTP streams */
411 typedef struct sctp_instr_s {
412 	mblk_t		*istr_msgs;
413 	int		istr_nmsgs;
414 	uint16_t	nextseq;
415 	struct sctp_s	*sctp;
416 	mblk_t		*istr_reass;
417 } sctp_instr_t;
418 
419 /* Reassembly data structure (per-stream) */
420 typedef struct sctp_reass_s {
421 	uint16_t	ssn;
422 	uint16_t	needed;
423 	uint16_t	got;
424 	uint16_t	msglen;		/* len of consecutive fragments */
425 					/* from the begining (B-bit) */
426 	mblk_t		*tail;
427 	boolean_t	hasBchunk;	/* If the fragment list begins with */
428 					/* a B-bit set chunk */
429 	uint32_t	nexttsn;	/* TSN of the next fragment we */
430 					/* are expecting */
431 	boolean_t	partial_delivered;
432 } sctp_reass_t;
433 
434 /* debugging */
435 #undef	dprint
436 #ifdef DEBUG
437 extern int sctpdebug;
438 #define	dprint(level, args)	{ if (sctpdebug > (level)) printf args; }
439 #else
440 #define	dprint(level, args) {}
441 #endif
442 
443 
444 /* Peer address tracking */
445 
446 /*
447  * States for peer addresses
448  *
449  * SCTP_FADDRS_UNCONFIRMED: we have not communicated with this peer address
450  *     before, mark it as unconfirmed so that we will not send data to it.
451  *     All addresses initially are in unconfirmed state and required
452  *     validation.  SCTP sends a heartbeat to each of them and when it gets
453  *     back a heartbeat ACK, the address will be marked as alive.  This
454  *     validation fixes a security issue with multihoming.  If an attacker
455  *     establishes an association with us and tells us that it has addresses
456  *     belonging to another host A, this will prevent A from communicating
457  *     with us.  This is fixed by peer address validation.  In the above case,
458  *     A will respond with an abort.
459  *
460  * SCTP_FADDRS_ALIVE: this peer address is alive and we can communicate with
461  *     it with no problem.
462  *
463  * SCTP_FADDRS_DOWN: we have exceeded the retransmission limit to this
464  *     peer address.  Once an address is marked down, we will only send
465  *     a heartbeat to it every hb_interval in case it becomes alive now.
466  *
467  * SCTP_FADDRS_UNREACH: there is no suitable source address to send to
468  *     this peer address.  For example, the peer address is v6 but we only
469  *     have v4 addresses.  It is marked unreachable until there is an
470  *     address configuration change.  At that time, mark these addresses
471  *     as unconfirmed and try again to see if those unreachable addresses
472  *     are OK as we may have more source addresses.
473  */
474 typedef enum {
475 	SCTP_FADDRS_UNREACH,
476 	SCTP_FADDRS_DOWN,
477 	SCTP_FADDRS_ALIVE,
478 	SCTP_FADDRS_UNCONFIRMED
479 } faddr_state_t;
480 
481 typedef struct sctp_faddr_s {
482 	struct sctp_faddr_s *next;
483 	faddr_state_t	state;
484 
485 	in6_addr_t	faddr;
486 	in6_addr_t	saddr;
487 
488 	int64_t		hb_expiry;	/* time to retransmit heartbeat */
489 	uint32_t	hb_interval;	/* the heartbeat interval */
490 
491 	int		rto;		/* RTO in tick */
492 	int		srtt;		/* Smoothed RTT in tick */
493 	int		rttvar;		/* RTT variance in tick */
494 	uint32_t	rtt_updates;
495 	int		strikes;
496 	int		max_retr;
497 	uint32_t	sfa_pmss;
498 	uint32_t	cwnd;
499 	uint32_t	ssthresh;
500 	uint32_t	suna;		/* sent - unack'ed */
501 	uint32_t	pba;		/* partial bytes acked */
502 	uint32_t	acked;
503 	int64_t		lastactive;
504 	mblk_t		*timer_mp;	/* retransmission timer control */
505 	uint32_t
506 			hb_pending : 1,
507 			timer_running : 1,
508 			df : 1,
509 			pmtu_discovered : 1,
510 
511 			rc_timer_running : 1,
512 			isv4 : 1,
513 			hb_enabled : 1;
514 
515 	mblk_t		*rc_timer_mp;	/* reliable control chunk timer */
516 	ire_t		*ire;		/* cached IRE */
517 	uint32_t	T3expire;	/* # of times T3 timer expired */
518 
519 	uint64_t	hb_secret;	/* per addr "secret" in heartbeat */
520 	uint32_t	rxt_unacked;	/* # unack'ed retransmitted bytes */
521 } sctp_faddr_t;
522 
523 /* Flags to indicate supported address type in the PARM_SUP_ADDRS. */
524 #define	PARM_SUPP_V6	0x1
525 #define	PARM_SUPP_V4	0x2
526 
527 /*
528  * Set heartbeat interval plus jitter.  The jitter is supposed to be random,
529  * up to +/- 50% of the RTO.  We use gethrtime() here for  performance reason
530  * as the jitter does not really need to be "very" random.
531  */
532 #define	SET_HB_INTVL(fp)					\
533 	((fp)->hb_interval + (fp)->rto + ((fp)->rto >> 1) -	\
534 	(uint_t)gethrtime() % (fp)->rto)
535 
536 #define	SCTP_IPIF_HASH	16
537 
538 typedef	struct	sctp_ipif_hash_s {
539 	list_t	sctp_ipif_list;
540 	int	ipif_count;
541 } sctp_ipif_hash_t;
542 
543 
544 /*
545  * Initialize cwnd according to RFC 3390.  def_max_init_cwnd is
546  * either sctp_slow_start_initial or sctp_slow_start_after idle
547  * depending on the caller.
548  */
549 #define	SET_CWND(fp, mss, def_max_init_cwnd)				\
550 {									\
551 	(fp)->cwnd = MIN(def_max_init_cwnd * (mss),			\
552 	    MIN(4 * (mss), MAX(2 * (mss), 4380 / (mss) * (mss))));	\
553 }
554 
555 
556 struct sctp_s;
557 
558 /*
559  * Control structure for each open SCTP stream,
560  * defined only within the kernel or for a kmem user.
561  * NOTE: sctp_reinit_values MUST have a line for each field in this structure!
562  */
563 #if (defined(_KERNEL) || defined(_KMEMUSER))
564 
565 typedef struct sctp_s {
566 
567 	/*
568 	 * The following is shared with (and duplicated) in IP, so if you
569 	 * make changes, make sure you also change things in ip_sctp.c.
570 	 */
571 	struct sctp_s	*sctp_conn_hash_next;
572 	struct sctp_s	*sctp_conn_hash_prev;
573 
574 	struct sctp_s	*sctp_listen_hash_next;
575 	struct sctp_s	*sctp_listen_hash_prev;
576 
577 	sctp_tf_t	*sctp_listen_tfp;	/* Ptr to tf */
578 	sctp_tf_t	*sctp_conn_tfp;		/* Ptr to tf */
579 
580 	/* Global list of sctp */
581 	list_node_t	sctp_list;
582 
583 	sctp_faddr_t		*sctp_faddrs;
584 	int			sctp_nfaddrs;
585 	sctp_ipif_hash_t	sctp_saddrs[SCTP_IPIF_HASH];
586 	int			sctp_nsaddrs;
587 
588 	/*
589 	 * These fields contain the same information as sctp_sctph->th_*port.
590 	 * However, the lookup functions can not use the header fields
591 	 * since during IP option manipulation the sctp_sctph pointer
592 	 * changes.
593 	 */
594 	union {
595 		struct {
596 			in_port_t	sctpu_fport;	/* Remote port */
597 			in_port_t	sctpu_lport;	/* Local port */
598 		} sctpu_ports1;
599 		uint32_t		sctpu_ports2;	/* Rem port, */
600 							/* local port */
601 					/* Used for SCTP_MATCH performance */
602 	} sctp_sctpu;
603 #define	sctp_fport	sctp_sctpu.sctpu_ports1.sctpu_fport
604 #define	sctp_lport	sctp_sctpu.sctpu_ports1.sctpu_lport
605 #define	sctp_ports	sctp_sctpu.sctpu_ports2
606 
607 	kmutex_t	sctp_lock;
608 	kcondvar_t	sctp_cv;
609 	boolean_t	sctp_running;
610 
611 #define	sctp_ulpd	sctp_connp->conn_upper_handle
612 #define	sctp_upcalls	sctp_connp->conn_upcalls
613 
614 #define	sctp_ulp_newconn	sctp_upcalls->su_newconn
615 #define	sctp_ulp_connected	sctp_upcalls->su_connected
616 #define	sctp_ulp_disconnected	sctp_upcalls->su_disconnected
617 #define	sctp_ulp_opctl		sctp_upcalls->su_opctl
618 #define	sctp_ulp_recv		sctp_upcalls->su_recv
619 #define	sctp_ulp_xmitted	sctp_upcalls->su_txq_full
620 #define	sctp_ulp_prop		sctp_upcalls->su_set_proto_props
621 
622 	int32_t		sctp_state;
623 
624 	conn_t		*sctp_connp;		/* conn_t stuff */
625 #define	sctp_zoneid	sctp_connp->conn_zoneid
626 #define	sctp_allzones	sctp_connp->conn_allzones
627 #define	sctp_mac_exempt	sctp_connp->conn_mac_exempt
628 #define	sctp_credp	sctp_connp->conn_cred
629 #define	sctp_reuseaddr	sctp_connp->conn_reuseaddr
630 
631 	sctp_stack_t	*sctp_sctps;
632 
633 	/* Peer address tracking */
634 	sctp_faddr_t	*sctp_lastfaddr;	/* last faddr in list */
635 	sctp_faddr_t	*sctp_primary;		/* primary faddr */
636 	sctp_faddr_t	*sctp_current;		/* current faddr */
637 	sctp_faddr_t	*sctp_lastdata;		/* last data seen from this */
638 
639 	/* Outbound data tracking */
640 	mblk_t		*sctp_xmit_head;
641 	mblk_t		*sctp_xmit_tail;
642 	mblk_t		*sctp_xmit_unsent;
643 	mblk_t		*sctp_xmit_unsent_tail;
644 	mblk_t		*sctp_xmit_unacked;
645 
646 	int32_t		sctp_unacked;		/* # of unacked bytes */
647 	int32_t		sctp_unsent;		/* # of unsent bytes in hand */
648 
649 	uint32_t	sctp_ltsn;		/* Local instance TSN */
650 	uint32_t	sctp_lastack_rxd;	/* Last rx'd cumtsn */
651 	uint32_t	sctp_recovery_tsn;	/* Exit from fast recovery */
652 	uint32_t	sctp_adv_pap;		/* Adv. Peer Ack Point */
653 
654 	uint16_t	sctp_num_ostr;
655 	uint16_t	*sctp_ostrcntrs;
656 
657 	mblk_t		*sctp_pad_mp;		/* pad unaligned data chunks */
658 
659 	/* sendmsg() default parameters */
660 	uint16_t	sctp_def_stream;	/* default stream id */
661 	uint16_t	sctp_def_flags;		/* default xmit flags */
662 	uint32_t	sctp_def_ppid;		/* default payload id */
663 	uint32_t	sctp_def_context;	/* default context */
664 	uint32_t	sctp_def_timetolive;	/* default msg TTL */
665 
666 	/* Inbound data tracking */
667 	sctp_set_t	*sctp_sack_info;	/* Sack tracking */
668 	mblk_t		*sctp_ack_mp;		/* Delayed ACK timer block */
669 	sctp_instr_t	*sctp_instr;		/* Instream trackers */
670 	mblk_t		*sctp_uo_frags;		/* Un-ordered msg. fragments */
671 	uint32_t	sctp_ftsn;		/* Peer's TSN */
672 	uint32_t	sctp_lastacked;		/* last cumtsn SACKd */
673 	uint16_t	sctp_num_istr;		/* No. of instreams */
674 	int32_t		sctp_istr_nmsgs;	/* No. of chunks in instreams */
675 	int32_t		sctp_sack_gaps;		/* No. of received gaps */
676 	int32_t		sctp_sack_toggle;	/* SACK every other pkt */
677 
678 	/* RTT calculation */
679 	uint32_t	sctp_rtt_tsn;
680 	int64_t		sctp_out_time;
681 
682 	/* Stats */
683 	uint64_t	sctp_opkts;		/* sent pkts */
684 	uint64_t	sctp_obchunks;		/* sent control chunks */
685 	uint64_t	sctp_odchunks;		/* sent ordered data chunks */
686 	uint64_t	sctp_oudchunks;		/* sent unord data chunks */
687 	uint64_t	sctp_rxtchunks;		/* retransmitted chunks */
688 	uint64_t	sctp_ipkts;		/* recv pkts */
689 	uint64_t	sctp_ibchunks;		/* recv control chunks */
690 	uint64_t	sctp_idchunks;		/* recv ordered data chunks */
691 	uint64_t	sctp_iudchunks;		/* recv unord data chunks */
692 	uint64_t	sctp_fragdmsgs;
693 	uint64_t	sctp_reassmsgs;
694 	uint32_t	sctp_T1expire;		/* # of times T1timer expired */
695 	uint32_t	sctp_T2expire;		/* # of times T2timer expired */
696 	uint32_t	sctp_T3expire;		/* # of times T3timer expired */
697 	uint32_t	sctp_assoc_start_time;	/* time when assoc was est. */
698 
699 	/* Outbound flow control */
700 	int32_t		sctp_xmit_hiwater;	/* Send high water mark */
701 	int32_t		sctp_xmit_lowater;	/* Send low water mark */
702 	uint32_t	sctp_frwnd;		/* Peer RWND */
703 	uint32_t	sctp_cwnd_max;
704 
705 	/* Inbound flow control */
706 	int32_t		sctp_rwnd;		/* Current receive window */
707 	int32_t		sctp_irwnd;		/* Initial receive window */
708 	int32_t		sctp_rxqueued;		/* No. of bytes in RX q's */
709 
710 	/* Pre-initialized composite headers */
711 	char		*sctp_iphc;	/* v4 sctp/ip hdr template buffer */
712 	char		*sctp_iphc6;	/* v6 sctp/ip hdr template buffer */
713 
714 	int32_t		sctp_iphc_len;	/* actual allocated v4 buffer size */
715 	int32_t		sctp_iphc6_len;	/* actual allocated v6 buffer size */
716 
717 	int32_t		sctp_hdr_len;	/* len of combined SCTP/IP v4 hdr */
718 	int32_t		sctp_hdr6_len;	/* len of combined SCTP/IP v6 hdr */
719 
720 	ipha_t		*sctp_ipha;	/* IPv4 header in the buffer */
721 	ip6_t		*sctp_ip6h;	/* IPv6 header in the buffer */
722 
723 	int32_t		sctp_ip_hdr_len; /* Byte len of our current v4 hdr */
724 	int32_t		sctp_ip_hdr6_len; /* Byte len of our current v6 hdr */
725 
726 	sctp_hdr_t	*sctp_sctph;	/* sctp header in combined v4 hdr */
727 	sctp_hdr_t	*sctp_sctph6;	/* sctp header in combined v6 hdr */
728 
729 	uint32_t	sctp_lvtag;	/* local SCTP instance verf tag */
730 	uint32_t	sctp_fvtag;	/* Peer's SCTP verf tag */
731 
732 	/* Path MTU Discovery */
733 	int64_t		sctp_last_mtu_probe;
734 	clock_t		sctp_mtu_probe_intvl;
735 	uint32_t	sctp_mss;	/* Max send size (not TCP MSS!) */
736 
737 	/* structs sctp_bits, sctp_events are for clearing all bits at once */
738 	struct {
739 		uint32_t
740 
741 		sctp_understands_asconf : 1, /* Peer handles ASCONF chunks */
742 		sctp_debug : 1,		/* SO_DEBUG "socket" option. */
743 		sctp_cchunk_pend : 1,	/* Control chunk in flight. */
744 		sctp_dgram_errind : 1,	/* SO_DGRAM_ERRIND option */
745 
746 		sctp_linger : 1,	/* SO_LINGER turned on */
747 		sctp_lingering : 1,	/* Lingering in close */
748 		sctp_loopback: 1,	/* src and dst are the same machine */
749 		sctp_force_sack : 1,
750 
751 		sctp_ack_timer_running: 1,	/* Delayed ACK timer running */
752 		sctp_recvdstaddr : 1,	/* return T_EXTCONN_IND with dstaddr */
753 		sctp_hwcksum : 1,	/* The NIC is capable of hwcksum */
754 		sctp_understands_addip : 1,
755 
756 		sctp_bound_to_all : 1,
757 		sctp_cansleep : 1,	/* itf routines can sleep */
758 		sctp_detached : 1,	/* If we're detached from a stream */
759 		sctp_send_adaptation : 1,	/* send adaptation layer ind */
760 
761 		sctp_recv_adaptation : 1,	/* recv adaptation layer ind */
762 		sctp_ndelay : 1,	/* turn off Nagle */
763 		sctp_condemned : 1,	/* this sctp is about to disappear */
764 		sctp_chk_fast_rexmit : 1, /* check for fast rexmit message */
765 
766 		sctp_prsctp_aware : 1,	/* is peer PR-SCTP aware? */
767 		sctp_linklocal : 1,	/* is linklocal assoc. */
768 		sctp_rexmitting : 1,	/* SCTP is retransmitting */
769 		sctp_zero_win_probe : 1,	/* doing zero win probe */
770 
771 		sctp_txq_full : 1,	/* the tx queue is full */
772 		sctp_ulp_discon_done : 1,	/* ulp_disconnecting done */
773 		sctp_dummy : 6;
774 	} sctp_bits;
775 	struct {
776 		uint32_t
777 
778 		sctp_recvsndrcvinfo : 1,
779 		sctp_recvassocevnt : 1,
780 		sctp_recvpathevnt : 1,
781 		sctp_recvsendfailevnt : 1,
782 
783 		sctp_recvpeererr : 1,
784 		sctp_recvshutdownevnt : 1,
785 		sctp_recvpdevnt : 1,
786 		sctp_recvalevnt : 1;
787 	} sctp_events;
788 #define	sctp_priv_stream sctp_bits.sctp_priv_stream
789 #define	sctp_understands_asconf sctp_bits.sctp_understands_asconf
790 #define	sctp_debug sctp_bits.sctp_debug
791 #define	sctp_cchunk_pend sctp_bits.sctp_cchunk_pend
792 #define	sctp_dgram_errind sctp_bits.sctp_dgram_errind
793 #define	sctp_linger sctp_bits.sctp_linger
794 #define	sctp_lingering sctp_bits.sctp_lingering
795 #define	sctp_loopback sctp_bits.sctp_loopback
796 #define	sctp_force_sack sctp_bits.sctp_force_sack
797 #define	sctp_ack_timer_running sctp_bits.sctp_ack_timer_running
798 #define	sctp_recvdstaddr sctp_bits.sctp_recvdstaddr
799 #define	sctp_hwcksum sctp_bits.sctp_hwcksum
800 #define	sctp_understands_addip sctp_bits.sctp_understands_addip
801 #define	sctp_bound_to_all sctp_bits.sctp_bound_to_all
802 #define	sctp_cansleep sctp_bits.sctp_cansleep
803 #define	sctp_detached sctp_bits.sctp_detached
804 #define	sctp_send_adaptation sctp_bits.sctp_send_adaptation
805 #define	sctp_recv_adaptation sctp_bits.sctp_recv_adaptation
806 #define	sctp_ndelay sctp_bits.sctp_ndelay
807 #define	sctp_condemned sctp_bits.sctp_condemned
808 #define	sctp_chk_fast_rexmit sctp_bits.sctp_chk_fast_rexmit
809 #define	sctp_prsctp_aware sctp_bits.sctp_prsctp_aware
810 #define	sctp_linklocal sctp_bits.sctp_linklocal
811 #define	sctp_rexmitting sctp_bits.sctp_rexmitting
812 #define	sctp_zero_win_probe sctp_bits.sctp_zero_win_probe
813 #define	sctp_txq_full sctp_bits.sctp_txq_full
814 #define	sctp_ulp_discon_done sctp_bits.sctp_ulp_discon_done
815 
816 #define	sctp_recvsndrcvinfo sctp_events.sctp_recvsndrcvinfo
817 #define	sctp_recvassocevnt sctp_events.sctp_recvassocevnt
818 #define	sctp_recvpathevnt sctp_events.sctp_recvpathevnt
819 #define	sctp_recvsendfailevnt sctp_events.sctp_recvsendfailevnt
820 #define	sctp_recvpeererr sctp_events.sctp_recvpeererr
821 #define	sctp_recvshutdownevnt sctp_events.sctp_recvshutdownevnt
822 #define	sctp_recvpdevnt sctp_events.sctp_recvpdevnt
823 #define	sctp_recvalevnt sctp_events.sctp_recvalevnt
824 
825 	/* Retransmit info */
826 	mblk_t		*sctp_cookie_mp; /* cookie chunk, if rxt needed */
827 	int32_t		sctp_strikes;	/* Total number of assoc strikes */
828 	int32_t		sctp_max_init_rxt;
829 	int32_t		sctp_pa_max_rxt; /* Max per-assoc retransmit cnt */
830 	int32_t		sctp_pp_max_rxt; /* Max per-path retransmit cnt */
831 	uint32_t	sctp_rto_max;
832 	uint32_t	sctp_init_rto_max;
833 	uint32_t	sctp_rto_min;
834 	uint32_t	sctp_rto_initial;
835 
836 	int64_t		sctp_last_secret_update;
837 	uint8_t		sctp_secret[SCTP_SECRET_LEN]; /* for cookie auth */
838 	uint8_t		sctp_old_secret[SCTP_SECRET_LEN];
839 	uint32_t	sctp_cookie_lifetime;	/* cookie lifetime in tick */
840 
841 	/*
842 	 * Address family that app wishes returned addrsses to be in.
843 	 * Currently taken from address family used in T_BIND_REQ, but
844 	 * should really come from family used in original socket() call.
845 	 * Value can be AF_INET or AF_INET6.
846 	 */
847 	uint_t		sctp_family;
848 	ushort_t	sctp_ipversion;
849 
850 	/* Bind hash tables */
851 	kmutex_t	*sctp_bind_lockp;	/* Ptr to tf_lock */
852 	struct sctp_s	*sctp_bind_hash;
853 	struct sctp_s **sctp_ptpbhn;
854 
855 	/* Shutdown / cleanup */
856 	sctp_faddr_t	*sctp_shutdown_faddr;	/* rotate faddr during shutd */
857 	int32_t		sctp_client_errno;	/* How the client screwed up */
858 	int		sctp_lingertime; /* Close linger time (in seconds) */
859 	kmutex_t	sctp_reflock;	/* Protects sctp_refcnt & timer mp */
860 	ushort_t	sctp_refcnt;	/* No. of pending upstream msg */
861 	mblk_t		*sctp_timer_mp;	/* List of fired timers. */
862 
863 	/* Misc */
864 	uint_t		sctp_bound_if;	/* IPV6_BOUND_IF */
865 
866 	mblk_t		*sctp_heartbeat_mp; /* Timer block for heartbeats */
867 	uint32_t	sctp_hb_interval; /* Default hb_interval */
868 
869 	int32_t		sctp_autoclose;	/* Auto disconnect in ticks */
870 	int64_t		sctp_active;	/* Last time data/sack on this conn */
871 	uint32_t	sctp_tx_adaptation_code; /* TX adaptation code */
872 	uint32_t	sctp_rx_adaptation_code; /* RX adaptation code */
873 
874 	/* Reliable control chunks */
875 	mblk_t		*sctp_cxmit_list; /* Xmit list for control chunks */
876 	uint32_t	sctp_lcsn;	/* Our serial number */
877 	uint32_t	sctp_fcsn;	/* Peer serial number */
878 
879 	/* Per association receive queue */
880 	kmutex_t	sctp_recvq_lock;
881 	mblk_t		*sctp_recvq;
882 	mblk_t		*sctp_recvq_tail;
883 	taskq_t		*sctp_recvq_tq;
884 
885 	/* Send queue to IP */
886 	kmutex_t	sctp_sendq_lock;
887 	mblk_t		*sctp_sendq;
888 	mblk_t		*sctp_sendq_tail;
889 	boolean_t	sctp_sendq_sending;
890 
891 	/* IPv6 ancillary data */
892 	uint_t		sctp_ipv6_recvancillary;	/* flags */
893 #define	SCTP_IPV6_RECVPKTINFO	0x01		/* IPV6_RECVPKTINFO opt */
894 #define	SCTP_IPV6_RECVHOPLIMIT	0x02		/* IPV6_RECVHOPLIMIT opt */
895 #define	SCTP_IPV6_RECVHOPOPTS	0x04		/* IPV6_RECVHOPOPTS opt */
896 #define	SCTP_IPV6_RECVDSTOPTS	0x08		/* IPV6_RECVDSTOPTS opt */
897 #define	SCTP_IPV6_RECVRTHDR	0x10		/* IPV6_RECVRTHDR opt */
898 #define	SCTP_IPV6_RECVRTDSTOPTS	0x20		/* IPV6_RECVRTHDRDSTOPTS opt */
899 
900 	uint_t		sctp_recvifindex;	/* last rcvd IPV6_RCVPKTINFO */
901 	uint_t		sctp_recvhops;		/*  " IPV6_RECVHOPLIMIT */
902 	ip6_hbh_t	*sctp_hopopts;		/*  " IPV6_RECVHOPOPTS */
903 	ip6_dest_t	*sctp_dstopts;		/*  " IPV6_RECVDSTOPTS */
904 	ip6_dest_t	*sctp_rtdstopts;	/*  " IPV6_RECVRTHDRDSTOPTS */
905 	ip6_rthdr_t	*sctp_rthdr;		/*  " IPV6_RECVRTHDR */
906 	uint_t		sctp_hopoptslen;
907 	uint_t		sctp_dstoptslen;
908 	uint_t		sctp_rtdstoptslen;
909 	uint_t		sctp_rthdrlen;
910 
911 	ip6_pkt_t	sctp_sticky_ipp;	/* Sticky options */
912 #define	sctp_ipp_fields		sctp_sticky_ipp.ipp_fields
913 #define	sctp_ipp_ifindex	sctp_sticky_ipp.ipp_ifindex
914 #define	sctp_ipp_addr		sctp_sticky_ipp.ipp_addr
915 #define	sctp_ipp_hoplimit	sctp_sticky_ipp.ipp_hoplimit
916 #define	sctp_ipp_hopoptslen	sctp_sticky_ipp.ipp_hopoptslen
917 #define	sctp_ipp_rtdstoptslen	sctp_sticky_ipp.ipp_rtdstoptslen
918 #define	sctp_ipp_rthdrlen	sctp_sticky_ipp.ipp_rthdrlen
919 #define	sctp_ipp_dstoptslen	sctp_sticky_ipp.ipp_dstoptslen
920 #define	sctp_ipp_hopopts	sctp_sticky_ipp.ipp_hopopts
921 #define	sctp_ipp_rtdstopts	sctp_sticky_ipp.ipp_rtdstopts
922 #define	sctp_ipp_rthdr		sctp_sticky_ipp.ipp_rthdr
923 #define	sctp_ipp_dstopts	sctp_sticky_ipp.ipp_dstopts
924 #define	sctp_ipp_pathmtu	sctp_sticky_ipp.ipp_pathmtu
925 #define	sctp_ipp_nexthop	sctp_sticky_ipp.ipp_nexthop
926 	/* Stats */
927 	uint64_t	sctp_msgcount;
928 	uint64_t	sctp_prsctpdrop;
929 
930 	uint_t		sctp_v4label_len;	/* length of cached v4 label */
931 	uint_t		sctp_v6label_len;	/* length of cached v6 label */
932 	uint32_t	sctp_rxt_nxttsn;	/* Next TSN to be rexmitted */
933 	uint32_t	sctp_rxt_maxtsn;	/* Max TSN sent at time out */
934 
935 	int		sctp_pd_point;		/* Partial delivery point */
936 	mblk_t		*sctp_err_chunks;	/* Error chunks */
937 	uint32_t	sctp_err_len;		/* Total error chunks length */
938 
939 	pid_t		sctp_cpid;	/* Process id when this was opened */
940 	uint64_t	sctp_open_time;	/* time when this was opened */
941 } sctp_t;
942 
943 #define	SCTP_TXQ_LEN(sctp)	((sctp)->sctp_unsent + (sctp)->sctp_unacked)
944 #define	SCTP_TXQ_UPDATE(sctp)					\
945 	if ((sctp)->sctp_txq_full && SCTP_TXQ_LEN(sctp) <=	\
946 	    (sctp)->sctp_xmit_lowater) {			\
947 		(sctp)->sctp_txq_full = 0;			\
948 		(sctp)->sctp_ulp_xmitted((sctp)->sctp_ulpd,	\
949 		    B_FALSE);					\
950 	}
951 
952 #endif	/* (defined(_KERNEL) || defined(_KMEMUSER)) */
953 
954 extern void	sctp_ack_timer(sctp_t *);
955 extern size_t	sctp_adaptation_code_param(sctp_t *, uchar_t *);
956 extern void	sctp_adaptation_event(sctp_t *);
957 extern void	sctp_add_err(sctp_t *, uint16_t, void *, size_t,
958 		    sctp_faddr_t *);
959 extern int	sctp_add_faddr(sctp_t *, in6_addr_t *, int, boolean_t);
960 extern boolean_t sctp_add_ftsn_set(sctp_ftsn_set_t **, sctp_faddr_t *, mblk_t *,
961 		    uint_t *, uint32_t *);
962 extern boolean_t sctp_add_recvq(sctp_t *, mblk_t *, boolean_t);
963 extern void	sctp_add_sendq(sctp_t *, mblk_t *);
964 extern void	sctp_add_unrec_parm(sctp_parm_hdr_t *, mblk_t **, boolean_t);
965 extern size_t	sctp_addr_params(sctp_t *, int, uchar_t *, boolean_t);
966 extern mblk_t	*sctp_add_proto_hdr(sctp_t *, sctp_faddr_t *, mblk_t *, int,
967 		    int *);
968 extern void	sctp_addr_req(sctp_t *, mblk_t *);
969 extern sctp_t	*sctp_addrlist2sctp(mblk_t *, sctp_hdr_t *, sctp_chunk_hdr_t *,
970 		    zoneid_t, sctp_stack_t *);
971 extern void	sctp_add_hdr(sctp_t *, uchar_t *, size_t);
972 extern void	sctp_check_adv_ack_pt(sctp_t *, mblk_t *, mblk_t *);
973 extern void	sctp_assoc_event(sctp_t *, uint16_t, uint16_t,
974 		    sctp_chunk_hdr_t *);
975 
976 extern void	sctp_bind_hash_insert(sctp_tf_t *, sctp_t *, int);
977 extern void	sctp_bind_hash_remove(sctp_t *);
978 extern int	sctp_bindi(sctp_t *, in_port_t, boolean_t, int, in_port_t *);
979 extern int	sctp_bind_add(sctp_t *, const void *, uint32_t, boolean_t,
980 		    in_port_t);
981 extern int	sctp_bind_del(sctp_t *, const void *, uint32_t, boolean_t);
982 extern int	sctp_build_hdrs(sctp_t *);
983 
984 extern int	sctp_check_abandoned_msg(sctp_t *, mblk_t *);
985 extern void	sctp_chunkify(sctp_t *, int, int);
986 extern void	sctp_clean_death(sctp_t *, int);
987 extern void	sctp_close_eager(sctp_t *);
988 extern int	sctp_compare_faddrsets(sctp_faddr_t *, sctp_faddr_t *);
989 extern void	sctp_congest_reset(sctp_t *);
990 extern void	sctp_conn_hash_insert(sctp_tf_t *, sctp_t *, int);
991 extern void	sctp_conn_hash_remove(sctp_t *);
992 extern void	sctp_conn_init(conn_t *);
993 extern sctp_t	*sctp_conn_match(in6_addr_t *, in6_addr_t *, uint32_t,
994 		    zoneid_t, sctp_stack_t *);
995 extern sctp_t	*sctp_conn_request(sctp_t *, mblk_t *, uint_t, uint_t,
996 		    sctp_init_chunk_t *, mblk_t *);
997 extern int	sctp_conprim_opt_process(queue_t *, mblk_t *, int *, int *,
998 		    int *);
999 extern uint32_t	sctp_cumack(sctp_t *, uint32_t, mblk_t **);
1000 extern sctp_t	*sctp_create_eager(sctp_t *);
1001 
1002 extern void	sctp_dispatch_rput(queue_t *, sctp_t *, sctp_hdr_t *, mblk_t *,
1003 		    uint_t, uint_t, in6_addr_t);
1004 extern char	*sctp_display(sctp_t *, char *);
1005 extern void	sctp_display_all(sctp_stack_t *);
1006 
1007 extern void	sctp_error_event(sctp_t *, sctp_chunk_hdr_t *);
1008 
1009 extern void	sctp_faddr_alive(sctp_t *, sctp_faddr_t *);
1010 extern int	sctp_faddr_dead(sctp_t *, sctp_faddr_t *, int);
1011 extern void	sctp_faddr_fini(void);
1012 extern void	sctp_faddr_init(void);
1013 extern void	sctp_fast_rexmit(sctp_t *);
1014 extern void	sctp_fill_sack(sctp_t *, unsigned char *, int);
1015 extern void	sctp_free_faddr_timers(sctp_t *);
1016 extern void	sctp_free_ftsn_set(sctp_ftsn_set_t *);
1017 extern void	sctp_free_msg(mblk_t *);
1018 extern void	sctp_free_reass(sctp_instr_t *);
1019 extern void	sctp_free_set(sctp_set_t *);
1020 extern void	sctp_ftsn_sets_fini(void);
1021 extern void	sctp_ftsn_sets_init(void);
1022 
1023 extern int	sctp_get_addrlist(sctp_t *, const void *, uint32_t *,
1024 		    uchar_t **, int *, size_t *);
1025 extern void	sctp_g_q_inactive(sctp_stack_t *);
1026 extern int	sctp_get_addrparams(sctp_t *, sctp_t *, mblk_t *,
1027 		    sctp_chunk_hdr_t *, uint_t *);
1028 extern void	sctp_get_ire(sctp_t *, sctp_faddr_t *);
1029 extern void	sctp_get_faddr_list(sctp_t *, uchar_t *, size_t);
1030 extern mblk_t	*sctp_get_first_sent(sctp_t *);
1031 extern mblk_t	*sctp_get_msg_to_send(sctp_t *, mblk_t **, mblk_t *, int  *,
1032 		    int32_t, uint32_t, sctp_faddr_t *);
1033 extern void	sctp_get_saddr_list(sctp_t *, uchar_t *, size_t);
1034 
1035 extern int	sctp_handle_error(sctp_t *, sctp_hdr_t *, sctp_chunk_hdr_t *,
1036 		    mblk_t *);
1037 extern void	sctp_hash_destroy(sctp_stack_t *);
1038 extern void	sctp_hash_init(sctp_stack_t *);
1039 extern int	sctp_header_init_ipv4(sctp_t *, int);
1040 extern int	sctp_header_init_ipv6(sctp_t *, int);
1041 extern void	sctp_heartbeat_timer(sctp_t *);
1042 
1043 extern void	sctp_icmp_error(sctp_t *, mblk_t *);
1044 extern void	sctp_inc_taskq(sctp_stack_t *);
1045 extern void	sctp_info_req(sctp_t *, mblk_t *);
1046 extern mblk_t	*sctp_init_mp(sctp_t *);
1047 extern boolean_t sctp_initialize_params(sctp_t *, sctp_init_chunk_t *,
1048 		    sctp_init_chunk_t *);
1049 extern uint32_t	sctp_init2vtag(sctp_chunk_hdr_t *);
1050 extern void	sctp_intf_event(sctp_t *, in6_addr_t, int, int);
1051 extern void	sctp_input_data(sctp_t *, mblk_t *, mblk_t *);
1052 extern void	sctp_instream_cleanup(sctp_t *, boolean_t);
1053 extern int	sctp_is_a_faddr_clean(sctp_t *);
1054 
1055 extern void	*sctp_kstat_init(netstackid_t);
1056 extern void	sctp_kstat_fini(netstackid_t, kstat_t *);
1057 extern void	*sctp_kstat2_init(netstackid_t, sctp_kstat_t *);
1058 extern void	sctp_kstat2_fini(netstackid_t, kstat_t *);
1059 
1060 extern ssize_t	sctp_link_abort(mblk_t *, uint16_t, char *, size_t, int,
1061 		    boolean_t);
1062 extern void	sctp_listen_hash_insert(sctp_tf_t *, sctp_t *);
1063 extern void	sctp_listen_hash_remove(sctp_t *);
1064 extern sctp_t	*sctp_lookup(sctp_t *, in6_addr_t *, sctp_tf_t *, uint32_t *,
1065 		    int);
1066 extern sctp_faddr_t *sctp_lookup_faddr(sctp_t *, in6_addr_t *);
1067 
1068 extern mblk_t	*sctp_make_err(sctp_t *, uint16_t, void *, size_t);
1069 extern mblk_t	*sctp_make_ftsn_chunk(sctp_t *, sctp_faddr_t *,
1070 		    sctp_ftsn_set_t *, uint_t, uint32_t);
1071 extern void	sctp_make_ftsns(sctp_t *, mblk_t *, mblk_t *, mblk_t **,
1072 		    sctp_faddr_t *, uint32_t *);
1073 extern mblk_t	*sctp_make_mp(sctp_t *, sctp_faddr_t *, int);
1074 extern mblk_t	*sctp_make_sack(sctp_t *, sctp_faddr_t *, mblk_t *);
1075 extern void	sctp_maxpsz_set(sctp_t *);
1076 extern void	sctp_move_faddr_timers(queue_t *, sctp_t *);
1077 
1078 extern void	sctp_nd_free(sctp_stack_t *);
1079 extern int	sctp_nd_getset(queue_t *, MBLKP);
1080 extern boolean_t sctp_nd_init(sctp_stack_t *);
1081 extern sctp_parm_hdr_t *sctp_next_parm(sctp_parm_hdr_t *, ssize_t *);
1082 
1083 extern void	sctp_ootb_shutdown_ack(sctp_t *, mblk_t *, uint_t);
1084 extern size_t	sctp_options_param(const sctp_t *, void *, int);
1085 extern size_t	sctp_options_param_len(const sctp_t *, int);
1086 extern void	sctp_output(sctp_t *, uint_t);
1087 
1088 extern boolean_t sctp_param_register(IDP *, sctpparam_t *, int, sctp_stack_t *);
1089 extern void	sctp_partial_delivery_event(sctp_t *);
1090 extern int	sctp_process_cookie(sctp_t *, sctp_chunk_hdr_t *, mblk_t *,
1091 		    sctp_init_chunk_t **, sctp_hdr_t *, int *, in6_addr_t *);
1092 extern void	sctp_process_err(sctp_t *);
1093 extern void	sctp_process_heartbeat(sctp_t *, sctp_chunk_hdr_t *);
1094 extern void	sctp_process_sendq(sctp_t *);
1095 extern void	sctp_process_timer(sctp_t *);
1096 
1097 extern void	sctp_redo_faddr_srcs(sctp_t *);
1098 extern void	sctp_regift_xmitlist(sctp_t *);
1099 extern void	sctp_return_heartbeat(sctp_t *, sctp_chunk_hdr_t *, mblk_t *);
1100 extern void	sctp_rexmit(sctp_t *, sctp_faddr_t *);
1101 extern mblk_t	*sctp_rexmit_packet(sctp_t *, mblk_t **, mblk_t **,
1102 		    sctp_faddr_t *, uint_t *);
1103 extern void	sctp_rexmit_timer(sctp_t *, sctp_faddr_t *);
1104 extern sctp_faddr_t *sctp_rotate_faddr(sctp_t *, sctp_faddr_t *);
1105 
1106 extern boolean_t sctp_sack(sctp_t *, mblk_t *);
1107 extern int	sctp_secure_restart_check(mblk_t *, sctp_chunk_hdr_t *,
1108 		    uint32_t, int, sctp_stack_t *);
1109 extern void	sctp_send_abort(sctp_t *, uint32_t, uint16_t, char *, size_t,
1110 		    mblk_t *, int, boolean_t);
1111 extern void	sctp_send_cookie_ack(sctp_t *);
1112 extern void	sctp_send_cookie_echo(sctp_t *, sctp_chunk_hdr_t *, mblk_t *);
1113 extern void	sctp_send_initack(sctp_t *, sctp_hdr_t *, sctp_chunk_hdr_t *,
1114 		    mblk_t *);
1115 extern void	sctp_send_shutdown(sctp_t *, int);
1116 extern void	sctp_send_heartbeat(sctp_t *, sctp_faddr_t *);
1117 extern void	sctp_sendfail_event(sctp_t *, mblk_t *, int, boolean_t);
1118 extern void	sctp_set_faddr_current(sctp_t *, sctp_faddr_t *);
1119 extern int	sctp_set_hdraddrs(sctp_t *);
1120 extern void	sctp_set_saddr(sctp_t *, sctp_faddr_t *);
1121 extern void	sctp_sets_init(void);
1122 extern void	sctp_sets_fini(void);
1123 extern void	sctp_shutdown_event(sctp_t *);
1124 extern void	sctp_stop_faddr_timers(sctp_t *);
1125 extern int	sctp_shutdown_received(sctp_t *, sctp_chunk_hdr_t *, boolean_t,
1126 		    boolean_t, sctp_faddr_t *);
1127 extern void	sctp_shutdown_complete(sctp_t *);
1128 extern void	sctp_set_if_mtu(sctp_t *);
1129 extern void	sctp_set_iplen(sctp_t *, mblk_t *);
1130 extern void	sctp_set_ulp_prop(sctp_t *);
1131 extern void	sctp_ss_rexmit(sctp_t *);
1132 extern size_t	sctp_supaddr_param_len(sctp_t *);
1133 extern size_t	sctp_supaddr_param(sctp_t *, uchar_t *);
1134 
1135 extern void	sctp_timer(sctp_t *, mblk_t *, clock_t);
1136 extern mblk_t	*sctp_timer_alloc(sctp_t *, pfv_t, int);
1137 extern void	sctp_timer_call(sctp_t *sctp, mblk_t *);
1138 extern void	sctp_timer_free(mblk_t *);
1139 extern void	sctp_timer_stop(mblk_t *);
1140 extern void	sctp_unlink_faddr(sctp_t *, sctp_faddr_t *);
1141 
1142 extern void	sctp_update_ire(sctp_t *sctp);
1143 extern in_port_t sctp_update_next_port(in_port_t, zone_t *zone, sctp_stack_t *);
1144 extern void	sctp_update_rtt(sctp_t *, sctp_faddr_t *, clock_t);
1145 extern void	sctp_user_abort(sctp_t *, mblk_t *);
1146 
1147 extern void	sctp_validate_peer(sctp_t *);
1148 
1149 extern void	sctp_wput_ioctl(queue_t *, mblk_t *);
1150 
1151 extern int	sctp_xmit_list_clean(sctp_t *, ssize_t);
1152 
1153 extern void	sctp_zap_addrs(sctp_t *);
1154 extern void	sctp_zap_faddrs(sctp_t *, int);
1155 
1156 /* Contract private interface between SCTP and Clustering - PSARC/2005/602 */
1157 
1158 extern void	(*cl_sctp_listen)(sa_family_t, uchar_t *, uint_t, in_port_t);
1159 extern void	(*cl_sctp_unlisten)(sa_family_t, uchar_t *, uint_t, in_port_t);
1160 extern void 	(*cl_sctp_connect)(sa_family_t, uchar_t *, uint_t, in_port_t,
1161 		    uchar_t *, uint_t, in_port_t, boolean_t, cl_sctp_handle_t);
1162 extern void	(*cl_sctp_disconnect)(sa_family_t, cl_sctp_handle_t);
1163 extern void	(*cl_sctp_assoc_change)(sa_family_t, uchar_t *, size_t, uint_t,
1164 		    uchar_t *, size_t, uint_t, int, cl_sctp_handle_t);
1165 extern void	(*cl_sctp_check_addrs)(sa_family_t, in_port_t, uchar_t **,
1166 		    size_t, uint_t *, boolean_t);
1167 
1168 /* Send a mp to IP. */
1169 #define	IP_PUT(mp, conn, isv4)						\
1170 {									\
1171 	sctp_stack_t	*sctps = conn->conn_netstack->netstack_sctp;	\
1172 									\
1173 	if ((isv4))							\
1174 		ip_output((conn), (mp), WR(sctps->sctps_g_q), IP_WPUT);	\
1175 	else								\
1176 		ip_output_v6((conn), (mp), WR(sctps->sctps_g_q), IP_WPUT);\
1177 }
1178 
1179 #define	RUN_SCTP(sctp)						\
1180 {								\
1181 	mutex_enter(&(sctp)->sctp_lock);			\
1182 	while ((sctp)->sctp_running)				\
1183 		cv_wait(&(sctp)->sctp_cv, &(sctp)->sctp_lock);	\
1184 	(sctp)->sctp_running = B_TRUE;				\
1185 	mutex_exit(&(sctp)->sctp_lock);				\
1186 }
1187 
1188 /* Wake up recvq taskq */
1189 #define	WAKE_SCTP(sctp)				\
1190 {						\
1191 	mutex_enter(&(sctp)->sctp_lock);	\
1192 	if ((sctp)->sctp_timer_mp != NULL)	\
1193 		sctp_process_timer(sctp);	\
1194 	(sctp)->sctp_running = B_FALSE;		\
1195 	cv_broadcast(&(sctp)->sctp_cv);		\
1196 	mutex_exit(&(sctp)->sctp_lock);		\
1197 }
1198 
1199 #ifdef	__cplusplus
1200 }
1201 #endif
1202 
1203 #endif	/* _INET_SCTP_SCTP_IMPL_H */
1204