xref: /titanic_50/usr/src/uts/common/inet/ip.h (revision 75eba5b6d79ed4d2ce3daf7b2806306b6b69a938)
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) 1991, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright (c) 2012, Joyent, Inc. All rights reserved.
25  * Copyright (c) 1990 Mentat Inc.
26  */
27 
28 #ifndef	_INET_IP_H
29 #define	_INET_IP_H
30 
31 #ifdef	__cplusplus
32 extern "C" {
33 #endif
34 
35 #include <sys/isa_defs.h>
36 #include <sys/types.h>
37 #include <inet/mib2.h>
38 #include <inet/nd.h>
39 #include <sys/atomic.h>
40 #include <net/if_dl.h>
41 #include <net/if.h>
42 #include <netinet/ip.h>
43 #include <netinet/igmp.h>
44 #include <sys/neti.h>
45 #include <sys/hook.h>
46 #include <sys/hook_event.h>
47 #include <sys/hook_impl.h>
48 #include <inet/ip_stack.h>
49 
50 #ifdef _KERNEL
51 #include <netinet/ip6.h>
52 #include <sys/avl.h>
53 #include <sys/list.h>
54 #include <sys/vmem.h>
55 #include <sys/squeue.h>
56 #include <net/route.h>
57 #include <sys/systm.h>
58 #include <net/radix.h>
59 #include <sys/modhash.h>
60 
61 #ifdef DEBUG
62 #define	CONN_DEBUG
63 #endif
64 
65 #define	IP_DEBUG
66 /*
67  * The mt-streams(9F) flags for the IP module; put here so that other
68  * "drivers" that are actually IP (e.g., ICMP, UDP) can use the same set
69  * of flags.
70  */
71 #define	IP_DEVMTFLAGS D_MP
72 #endif	/* _KERNEL */
73 
74 #define	IP_MOD_NAME	"ip"
75 #define	IP_DEV_NAME	"/dev/ip"
76 #define	IP6_DEV_NAME	"/dev/ip6"
77 
78 #define	UDP_MOD_NAME	"udp"
79 #define	UDP_DEV_NAME	"/dev/udp"
80 #define	UDP6_DEV_NAME	"/dev/udp6"
81 
82 #define	TCP_MOD_NAME	"tcp"
83 #define	TCP_DEV_NAME	"/dev/tcp"
84 #define	TCP6_DEV_NAME	"/dev/tcp6"
85 
86 #define	SCTP_MOD_NAME	"sctp"
87 
88 #ifndef	_IPADDR_T
89 #define	_IPADDR_T
90 typedef uint32_t ipaddr_t;
91 #endif
92 
93 /* Number of bits in an address */
94 #define	IP_ABITS		32
95 #define	IPV4_ABITS		IP_ABITS
96 #define	IPV6_ABITS		128
97 #define	IP_MAX_HW_LEN	40
98 
99 #define	IP_HOST_MASK		(ipaddr_t)0xffffffffU
100 
101 #define	IP_CSUM(mp, off, sum)		(~ip_cksum(mp, off, sum) & 0xFFFF)
102 #define	IP_CSUM_PARTIAL(mp, off, sum)	ip_cksum(mp, off, sum)
103 #define	IP_BCSUM_PARTIAL(bp, len, sum)	bcksum(bp, len, sum)
104 
105 #define	ILL_FRAG_HASH_TBL_COUNT	((unsigned int)64)
106 #define	ILL_FRAG_HASH_TBL_SIZE	(ILL_FRAG_HASH_TBL_COUNT * sizeof (ipfb_t))
107 
108 #define	IPV4_ADDR_LEN			4
109 #define	IP_ADDR_LEN			IPV4_ADDR_LEN
110 #define	IP_ARP_PROTO_TYPE		0x0800
111 
112 #define	IPV4_VERSION			4
113 #define	IP_VERSION			IPV4_VERSION
114 #define	IP_SIMPLE_HDR_LENGTH_IN_WORDS	5
115 #define	IP_SIMPLE_HDR_LENGTH		20
116 #define	IP_MAX_HDR_LENGTH		60
117 
118 #define	IP_MAX_OPT_LENGTH (IP_MAX_HDR_LENGTH-IP_SIMPLE_HDR_LENGTH)
119 
120 #define	IP_MIN_MTU			(IP_MAX_HDR_LENGTH + 8)	/* 68 bytes */
121 
122 /*
123  * XXX IP_MAXPACKET is defined in <netinet/ip.h> as well. At some point the
124  * 2 files should be cleaned up to remove all redundant definitions.
125  */
126 #define	IP_MAXPACKET			65535
127 #define	IP_SIMPLE_HDR_VERSION \
128 	((IP_VERSION << 4) | IP_SIMPLE_HDR_LENGTH_IN_WORDS)
129 
130 #define	UDPH_SIZE			8
131 
132 /*
133  * Constants and type definitions to support IP IOCTL commands
134  */
135 #define	IP_IOCTL			(('i'<<8)|'p')
136 #define	IP_IOC_IRE_DELETE		4
137 #define	IP_IOC_IRE_DELETE_NO_REPLY	5
138 #define	IP_IOC_RTS_REQUEST		7
139 
140 /* Common definitions used by IP IOCTL data structures */
141 typedef struct ipllcmd_s {
142 	uint_t	ipllc_cmd;
143 	uint_t	ipllc_name_offset;
144 	uint_t	ipllc_name_length;
145 } ipllc_t;
146 
147 /* IP IRE Delete Command Structure. */
148 typedef struct ipid_s {
149 	ipllc_t	ipid_ipllc;
150 	uint_t	ipid_ire_type;
151 	uint_t	ipid_addr_offset;
152 	uint_t	ipid_addr_length;
153 	uint_t	ipid_mask_offset;
154 	uint_t	ipid_mask_length;
155 } ipid_t;
156 
157 #define	ipid_cmd		ipid_ipllc.ipllc_cmd
158 
159 #ifdef _KERNEL
160 /*
161  * Temporary state for ip options parser.
162  */
163 typedef struct ipoptp_s
164 {
165 	uint8_t		*ipoptp_next;	/* next option to look at */
166 	uint8_t		*ipoptp_end;	/* end of options */
167 	uint8_t		*ipoptp_cur;	/* start of current option */
168 	uint8_t		ipoptp_len;	/* length of current option */
169 	uint32_t	ipoptp_flags;
170 } ipoptp_t;
171 
172 /*
173  * Flag(s) for ipoptp_flags
174  */
175 #define	IPOPTP_ERROR	0x00000001
176 #endif	/* _KERNEL */
177 
178 /* Controls forwarding of IP packets, set via ipadm(1M)/ndd(1M) */
179 #define	IP_FORWARD_NEVER	0
180 #define	IP_FORWARD_ALWAYS	1
181 
182 #define	WE_ARE_FORWARDING(ipst)	((ipst)->ips_ip_forwarding == IP_FORWARD_ALWAYS)
183 
184 #define	IPH_HDR_LENGTH(ipha)						\
185 	((int)(((ipha_t *)ipha)->ipha_version_and_hdr_length & 0xF) << 2)
186 
187 #define	IPH_HDR_VERSION(ipha)						\
188 	((int)(((ipha_t *)ipha)->ipha_version_and_hdr_length) >> 4)
189 
190 #ifdef _KERNEL
191 /*
192  * IP reassembly macros.  We hide starting and ending offsets in b_next and
193  * b_prev of messages on the reassembly queue.	The messages are chained using
194  * b_cont.  These macros are used in ip_reassemble() so we don't have to see
195  * the ugly casts and assignments.
196  * Note that the offsets are <= 64k i.e. a uint_t is sufficient to represent
197  * them.
198  */
199 #define	IP_REASS_START(mp)		((uint_t)(uintptr_t)((mp)->b_next))
200 #define	IP_REASS_SET_START(mp, u)	\
201 	((mp)->b_next = (mblk_t *)(uintptr_t)(u))
202 #define	IP_REASS_END(mp)		((uint_t)(uintptr_t)((mp)->b_prev))
203 #define	IP_REASS_SET_END(mp, u)		\
204 	((mp)->b_prev = (mblk_t *)(uintptr_t)(u))
205 
206 #define	IP_REASS_COMPLETE	0x1
207 #define	IP_REASS_PARTIAL	0x2
208 #define	IP_REASS_FAILED		0x4
209 
210 /*
211  * Test to determine whether this is a module instance of IP or a
212  * driver instance of IP.
213  */
214 #define	CONN_Q(q)	(WR(q)->q_next == NULL)
215 
216 #define	Q_TO_CONN(q)	((conn_t *)(q)->q_ptr)
217 #define	Q_TO_TCP(q)	(Q_TO_CONN((q))->conn_tcp)
218 #define	Q_TO_UDP(q)	(Q_TO_CONN((q))->conn_udp)
219 #define	Q_TO_ICMP(q)	(Q_TO_CONN((q))->conn_icmp)
220 #define	Q_TO_RTS(q)	(Q_TO_CONN((q))->conn_rts)
221 
222 #define	CONNP_TO_WQ(connp)	((connp)->conn_wq)
223 #define	CONNP_TO_RQ(connp)	((connp)->conn_rq)
224 
225 #define	GRAB_CONN_LOCK(q)	{				\
226 	if (q != NULL && CONN_Q(q))				\
227 		mutex_enter(&(Q_TO_CONN(q))->conn_lock);	\
228 }
229 
230 #define	RELEASE_CONN_LOCK(q)	{				\
231 	if (q != NULL && CONN_Q(q))				\
232 		mutex_exit(&(Q_TO_CONN(q))->conn_lock);		\
233 }
234 
235 /*
236  * Ref counter macros for ioctls. This provides a guard for TCP to stop
237  * tcp_close from removing the rq/wq whilst an ioctl is still in flight on the
238  * stream. The ioctl could have been queued on e.g. an ipsq. tcp_close will wait
239  * until the ioctlref count is zero before proceeding.
240  * Ideally conn_oper_pending_ill would be used for this purpose. However, in the
241  * case where an ioctl is aborted or interrupted, it can be cleared prematurely.
242  * There are also some race possibilities between ip and the stream head which
243  * can also end up with conn_oper_pending_ill being cleared prematurely. So, to
244  * avoid these situations, we use a dedicated ref counter for ioctls which is
245  * used in addition to and in parallel with the normal conn_ref count.
246  */
247 #define	CONN_INC_IOCTLREF_LOCKED(connp)	{			\
248 	ASSERT(MUTEX_HELD(&(connp)->conn_lock));		\
249 	DTRACE_PROBE1(conn__inc__ioctlref, conn_t *, (connp));	\
250 	(connp)->conn_ioctlref++;				\
251 	mutex_exit(&(connp)->conn_lock);			\
252 }
253 
254 #define	CONN_INC_IOCTLREF(connp)	{			\
255 	mutex_enter(&(connp)->conn_lock);			\
256 	CONN_INC_IOCTLREF_LOCKED(connp);			\
257 }
258 
259 #define	CONN_DEC_IOCTLREF(connp)	{			\
260 	mutex_enter(&(connp)->conn_lock);			\
261 	DTRACE_PROBE1(conn__dec__ioctlref, conn_t *, (connp));	\
262 	/* Make sure conn_ioctlref will not underflow. */	\
263 	ASSERT((connp)->conn_ioctlref != 0);			\
264 	if ((--(connp)->conn_ioctlref == 0) &&			\
265 	    ((connp)->conn_state_flags & CONN_CLOSING)) {	\
266 		cv_broadcast(&(connp)->conn_cv);		\
267 	}							\
268 	mutex_exit(&(connp)->conn_lock);			\
269 }
270 
271 
272 /*
273  * Complete the pending operation. Usually an ioctl. Can also
274  * be a bind or option management request that got enqueued
275  * in an ipsq_t. Called on completion of the operation.
276  */
277 #define	CONN_OPER_PENDING_DONE(connp)	{			\
278 	mutex_enter(&(connp)->conn_lock);			\
279 	(connp)->conn_oper_pending_ill = NULL;			\
280 	cv_broadcast(&(connp)->conn_refcv);			\
281 	mutex_exit(&(connp)->conn_lock);			\
282 	CONN_DEC_REF(connp);					\
283 }
284 
285 /*
286  * Values for squeue switch:
287  */
288 #define	IP_SQUEUE_ENTER_NODRAIN	1
289 #define	IP_SQUEUE_ENTER	2
290 #define	IP_SQUEUE_FILL 3
291 
292 extern int ip_squeue_flag;
293 
294 /* IP Fragmentation Reassembly Header */
295 typedef struct ipf_s {
296 	struct ipf_s	*ipf_hash_next;
297 	struct ipf_s	**ipf_ptphn;	/* Pointer to previous hash next. */
298 	uint32_t	ipf_ident;	/* Ident to match. */
299 	uint8_t		ipf_protocol;	/* Protocol to match. */
300 	uchar_t		ipf_last_frag_seen : 1;	/* Last fragment seen ? */
301 	time_t		ipf_timestamp;	/* Reassembly start time. */
302 	mblk_t		*ipf_mp;	/* mblk we live in. */
303 	mblk_t		*ipf_tail_mp;	/* Frag queue tail pointer. */
304 	int		ipf_hole_cnt;	/* Number of holes (hard-case). */
305 	int		ipf_end;	/* Tail end offset (0 -> hard-case). */
306 	uint_t		ipf_gen;	/* Frag queue generation */
307 	size_t		ipf_count;	/* Count of bytes used by frag */
308 	uint_t		ipf_nf_hdr_len; /* Length of nonfragmented header */
309 	in6_addr_t	ipf_v6src;	/* IPv6 source address */
310 	in6_addr_t	ipf_v6dst;	/* IPv6 dest address */
311 	uint_t		ipf_prev_nexthdr_offset; /* Offset for nexthdr value */
312 	uint8_t		ipf_ecn;	/* ECN info for the fragments */
313 	uint8_t		ipf_num_dups;	/* Number of times dup frags recvd */
314 	uint16_t	ipf_checksum_flags; /* Hardware checksum flags */
315 	uint32_t	ipf_checksum;	/* Partial checksum of fragment data */
316 } ipf_t;
317 
318 /*
319  * IPv4 Fragments
320  */
321 #define	IS_V4_FRAGMENT(ipha_fragment_offset_and_flags)			\
322 	(((ntohs(ipha_fragment_offset_and_flags) & IPH_OFFSET) != 0) ||	\
323 	((ntohs(ipha_fragment_offset_and_flags) & IPH_MF) != 0))
324 
325 #define	ipf_src	V4_PART_OF_V6(ipf_v6src)
326 #define	ipf_dst	V4_PART_OF_V6(ipf_v6dst)
327 
328 #endif /* _KERNEL */
329 
330 /* ICMP types */
331 #define	ICMP_ECHO_REPLY			0
332 #define	ICMP_DEST_UNREACHABLE		3
333 #define	ICMP_SOURCE_QUENCH		4
334 #define	ICMP_REDIRECT			5
335 #define	ICMP_ECHO_REQUEST		8
336 #define	ICMP_ROUTER_ADVERTISEMENT	9
337 #define	ICMP_ROUTER_SOLICITATION	10
338 #define	ICMP_TIME_EXCEEDED		11
339 #define	ICMP_PARAM_PROBLEM		12
340 #define	ICMP_TIME_STAMP_REQUEST		13
341 #define	ICMP_TIME_STAMP_REPLY		14
342 #define	ICMP_INFO_REQUEST		15
343 #define	ICMP_INFO_REPLY			16
344 #define	ICMP_ADDRESS_MASK_REQUEST	17
345 #define	ICMP_ADDRESS_MASK_REPLY		18
346 
347 /* Evaluates to true if the ICMP type is an ICMP error */
348 #define	ICMP_IS_ERROR(type)	(		\
349 	(type) == ICMP_DEST_UNREACHABLE ||	\
350 	(type) == ICMP_SOURCE_QUENCH ||		\
351 	(type) == ICMP_TIME_EXCEEDED ||		\
352 	(type) == ICMP_PARAM_PROBLEM)
353 
354 /* ICMP_TIME_EXCEEDED codes */
355 #define	ICMP_TTL_EXCEEDED		0
356 #define	ICMP_REASSEMBLY_TIME_EXCEEDED	1
357 
358 /* ICMP_DEST_UNREACHABLE codes */
359 #define	ICMP_NET_UNREACHABLE		0
360 #define	ICMP_HOST_UNREACHABLE		1
361 #define	ICMP_PROTOCOL_UNREACHABLE	2
362 #define	ICMP_PORT_UNREACHABLE		3
363 #define	ICMP_FRAGMENTATION_NEEDED	4
364 #define	ICMP_SOURCE_ROUTE_FAILED	5
365 #define	ICMP_DEST_NET_UNKNOWN		6
366 #define	ICMP_DEST_HOST_UNKNOWN		7
367 #define	ICMP_SRC_HOST_ISOLATED		8
368 #define	ICMP_DEST_NET_UNREACH_ADMIN	9
369 #define	ICMP_DEST_HOST_UNREACH_ADMIN	10
370 #define	ICMP_DEST_NET_UNREACH_TOS	11
371 #define	ICMP_DEST_HOST_UNREACH_TOS	12
372 
373 /* ICMP Header Structure */
374 typedef struct icmph_s {
375 	uint8_t		icmph_type;
376 	uint8_t		icmph_code;
377 	uint16_t	icmph_checksum;
378 	union {
379 		struct { /* ECHO request/response structure */
380 			uint16_t	u_echo_ident;
381 			uint16_t	u_echo_seqnum;
382 		} u_echo;
383 		struct { /* Destination unreachable structure */
384 			uint16_t	u_du_zero;
385 			uint16_t	u_du_mtu;
386 		} u_du;
387 		struct { /* Parameter problem structure */
388 			uint8_t		u_pp_ptr;
389 			uint8_t		u_pp_rsvd[3];
390 		} u_pp;
391 		struct { /* Redirect structure */
392 			ipaddr_t	u_rd_gateway;
393 		} u_rd;
394 	} icmph_u;
395 } icmph_t;
396 
397 #define	icmph_echo_ident	icmph_u.u_echo.u_echo_ident
398 #define	icmph_echo_seqnum	icmph_u.u_echo.u_echo_seqnum
399 #define	icmph_du_zero		icmph_u.u_du.u_du_zero
400 #define	icmph_du_mtu		icmph_u.u_du.u_du_mtu
401 #define	icmph_pp_ptr		icmph_u.u_pp.u_pp_ptr
402 #define	icmph_rd_gateway	icmph_u.u_rd.u_rd_gateway
403 
404 #define	ICMPH_SIZE	8
405 
406 /*
407  * Minimum length of transport layer header included in an ICMP error
408  * message for it to be considered valid.
409  */
410 #define	ICMP_MIN_TP_HDR_LEN	8
411 
412 /* Aligned IP header */
413 typedef struct ipha_s {
414 	uint8_t		ipha_version_and_hdr_length;
415 	uint8_t		ipha_type_of_service;
416 	uint16_t	ipha_length;
417 	uint16_t	ipha_ident;
418 	uint16_t	ipha_fragment_offset_and_flags;
419 	uint8_t		ipha_ttl;
420 	uint8_t		ipha_protocol;
421 	uint16_t	ipha_hdr_checksum;
422 	ipaddr_t	ipha_src;
423 	ipaddr_t	ipha_dst;
424 } ipha_t;
425 
426 /*
427  * IP Flags
428  *
429  * Some of these constant names are copied for the DTrace IP provider in
430  * usr/src/lib/libdtrace/common/{ip.d.in, ip.sed.in}, which should be kept
431  * in sync.
432  */
433 #define	IPH_DF		0x4000	/* Don't fragment */
434 #define	IPH_MF		0x2000	/* More fragments to come */
435 #define	IPH_OFFSET	0x1FFF	/* Where the offset lives */
436 
437 /* Byte-order specific values */
438 #ifdef	_BIG_ENDIAN
439 #define	IPH_DF_HTONS	0x4000	/* Don't fragment */
440 #define	IPH_MF_HTONS	0x2000	/* More fragments to come */
441 #define	IPH_OFFSET_HTONS 0x1FFF	/* Where the offset lives */
442 #else
443 #define	IPH_DF_HTONS	0x0040	/* Don't fragment */
444 #define	IPH_MF_HTONS	0x0020	/* More fragments to come */
445 #define	IPH_OFFSET_HTONS 0xFF1F	/* Where the offset lives */
446 #endif
447 
448 /* ECN code points for IPv4 TOS byte and IPv6 traffic class octet. */
449 #define	IPH_ECN_NECT	0x0	/* Not ECN-Capable Transport */
450 #define	IPH_ECN_ECT1	0x1	/* ECN-Capable Transport, ECT(1) */
451 #define	IPH_ECN_ECT0	0x2	/* ECN-Capable Transport, ECT(0) */
452 #define	IPH_ECN_CE	0x3	/* ECN-Congestion Experienced (CE) */
453 
454 struct ill_s;
455 
456 typedef	void ip_v6intfid_func_t(struct ill_s *, in6_addr_t *);
457 typedef void ip_v6mapinfo_func_t(struct ill_s *, uchar_t *, uchar_t *);
458 typedef void ip_v4mapinfo_func_t(struct ill_s *, uchar_t *, uchar_t *);
459 
460 /* IP Mac info structure */
461 typedef struct ip_m_s {
462 	t_uscalar_t		ip_m_mac_type;	/* From <sys/dlpi.h> */
463 	int			ip_m_type;	/* From <net/if_types.h> */
464 	t_uscalar_t		ip_m_ipv4sap;
465 	t_uscalar_t		ip_m_ipv6sap;
466 	ip_v4mapinfo_func_t	*ip_m_v4mapping;
467 	ip_v6mapinfo_func_t	*ip_m_v6mapping;
468 	ip_v6intfid_func_t	*ip_m_v6intfid;
469 	ip_v6intfid_func_t	*ip_m_v6destintfid;
470 } ip_m_t;
471 
472 /*
473  * The following functions attempt to reduce the link layer dependency
474  * of the IP stack. The current set of link specific operations are:
475  * a. map from IPv4 class D (224.0/4) multicast address range or the
476  * IPv6 multicast address range (ff00::/8) to the link layer multicast
477  * address.
478  * b. derive the default IPv6 interface identifier from the interface.
479  * c. derive the default IPv6 destination interface identifier from
480  * the interface (point-to-point only).
481  */
482 extern	void ip_mcast_mapping(struct ill_s *, uchar_t *, uchar_t *);
483 /* ip_m_v6*intfid return void and are never NULL */
484 #define	MEDIA_V6INTFID(ip_m, ill, v6ptr) (ip_m)->ip_m_v6intfid(ill, v6ptr)
485 #define	MEDIA_V6DESTINTFID(ip_m, ill, v6ptr) \
486 	(ip_m)->ip_m_v6destintfid(ill, v6ptr)
487 
488 /* Router entry types */
489 #define	IRE_BROADCAST		0x0001	/* Route entry for broadcast address */
490 #define	IRE_DEFAULT		0x0002	/* Route entry for default gateway */
491 #define	IRE_LOCAL		0x0004	/* Route entry for local address */
492 #define	IRE_LOOPBACK		0x0008	/* Route entry for loopback address */
493 #define	IRE_PREFIX		0x0010	/* Route entry for prefix routes */
494 #ifndef _KERNEL
495 /* Keep so user-level still compiles */
496 #define	IRE_CACHE		0x0020	/* Cached Route entry */
497 #endif
498 #define	IRE_IF_NORESOLVER	0x0040	/* Route entry for local interface */
499 					/* net without any address mapping. */
500 #define	IRE_IF_RESOLVER		0x0080	/* Route entry for local interface */
501 					/* net with resolver. */
502 #define	IRE_HOST		0x0100	/* Host route entry */
503 /* Keep so user-level still compiles */
504 #define	IRE_HOST_REDIRECT	0x0200	/* only used for T_SVR4_OPTMGMT_REQ */
505 #define	IRE_IF_CLONE		0x0400	/* Per host clone of IRE_IF */
506 #define	IRE_MULTICAST		0x0800	/* Special - not in table */
507 #define	IRE_NOROUTE		0x1000	/* Special - not in table */
508 
509 #define	IRE_INTERFACE		(IRE_IF_NORESOLVER | IRE_IF_RESOLVER)
510 
511 #define	IRE_IF_ALL		(IRE_IF_NORESOLVER | IRE_IF_RESOLVER | \
512 				    IRE_IF_CLONE)
513 #define	IRE_OFFSUBNET		(IRE_DEFAULT | IRE_PREFIX | IRE_HOST)
514 #define	IRE_OFFLINK		IRE_OFFSUBNET
515 /*
516  * Note that we view IRE_NOROUTE as ONLINK since we can "send" to them without
517  * going through a router; the result of sending will be an error/icmp error.
518  */
519 #define	IRE_ONLINK		(IRE_IF_ALL|IRE_LOCAL|IRE_LOOPBACK| \
520 				    IRE_BROADCAST|IRE_MULTICAST|IRE_NOROUTE)
521 
522 /* Arguments to ire_flush_cache() */
523 #define	IRE_FLUSH_DELETE	0
524 #define	IRE_FLUSH_ADD		1
525 #define	IRE_FLUSH_GWCHANGE	2
526 
527 /*
528  * Flags to ire_route_recursive
529  */
530 #define	IRR_NONE		0
531 #define	IRR_ALLOCATE		1	/* OK to allocate IRE_IF_CLONE */
532 #define	IRR_INCOMPLETE		2	/* OK to return incomplete chain */
533 
534 /*
535  * Open/close synchronization flags.
536  * These are kept in a separate field in the conn and the synchronization
537  * depends on the atomic 32 bit access to that field.
538  */
539 #define	CONN_CLOSING		0x01	/* ip_close waiting for ip_wsrv */
540 #define	CONN_CONDEMNED		0x02	/* conn is closing, no more refs */
541 #define	CONN_INCIPIENT		0x04	/* conn not yet visible, no refs */
542 #define	CONN_QUIESCED		0x08	/* conn is now quiescent */
543 #define	CONN_UPDATE_ILL		0x10	/* conn_update_ill in progress */
544 
545 /*
546  * Flags for dce_flags field. Specifies which information has been set.
547  * dce_ident is always present, but the other ones are identified by the flags.
548  */
549 #define	DCEF_DEFAULT		0x0001	/* Default DCE - no pmtu or uinfo */
550 #define	DCEF_PMTU		0x0002	/* Different than interface MTU */
551 #define	DCEF_UINFO		0x0004	/* dce_uinfo set */
552 #define	DCEF_TOO_SMALL_PMTU	0x0008	/* Smaller than IPv4/IPv6 MIN */
553 
554 #ifdef _KERNEL
555 /*
556  * Extra structures need for per-src-addr filtering (IGMPv3/MLDv2)
557  */
558 #define	MAX_FILTER_SIZE	64
559 
560 typedef struct slist_s {
561 	int		sl_numsrc;
562 	in6_addr_t	sl_addr[MAX_FILTER_SIZE];
563 } slist_t;
564 
565 /*
566  * Following struct is used to maintain retransmission state for
567  * a multicast group.  One rtx_state_t struct is an in-line field
568  * of the ilm_t struct; the slist_ts in the rtx_state_t struct are
569  * alloc'd as needed.
570  */
571 typedef struct rtx_state_s {
572 	uint_t		rtx_timer;	/* retrans timer */
573 	int		rtx_cnt;	/* retrans count */
574 	int		rtx_fmode_cnt;	/* retrans count for fmode change */
575 	slist_t		*rtx_allow;
576 	slist_t		*rtx_block;
577 } rtx_state_t;
578 
579 /*
580  * Used to construct list of multicast address records that will be
581  * sent in a single listener report.
582  */
583 typedef struct mrec_s {
584 	struct mrec_s	*mrec_next;
585 	uint8_t		mrec_type;
586 	uint8_t		mrec_auxlen;	/* currently unused */
587 	in6_addr_t	mrec_group;
588 	slist_t		mrec_srcs;
589 } mrec_t;
590 
591 /* Group membership list per upper conn */
592 
593 /*
594  * We record the multicast information from the socket option in
595  * ilg_ifaddr/ilg_ifindex. This allows rejoining the group in the case when
596  * the ifaddr (or ifindex) disappears and later reappears, potentially on
597  * a different ill. The IPv6 multicast socket options and ioctls all specify
598  * the interface using an ifindex. For IPv4 some socket options/ioctls use
599  * the interface address and others use the index. We record here the method
600  * that was actually used (and leave the other of ilg_ifaddr or ilg_ifindex)
601  * at zero so that we can rejoin the way the application intended.
602  *
603  * We track the ill on which we will or already have joined an ilm using
604  * ilg_ill. When we have succeeded joining the ilm and have a refhold on it
605  * then we set ilg_ilm. Thus intentionally there is a window where ilg_ill is
606  * set and ilg_ilm is not set. This allows clearing ilg_ill as a signal that
607  * the ill is being unplumbed and the ilm should be discarded.
608  *
609  * ilg records the state of multicast memberships of a socket end point.
610  * ilm records the state of multicast memberships with the driver and is
611  * maintained per interface.
612  *
613  * The ilg state is protected by conn_ilg_lock.
614  * The ilg will not be freed until ilg_refcnt drops to zero.
615  */
616 typedef struct ilg_s {
617 	struct ilg_s	*ilg_next;
618 	struct ilg_s	**ilg_ptpn;
619 	struct conn_s	*ilg_connp;	/* Back pointer to get lock */
620 	in6_addr_t	ilg_v6group;
621 	ipaddr_t	ilg_ifaddr;	/* For some IPv4 cases */
622 	uint_t		ilg_ifindex;	/* IPv6 and some other IPv4 cases */
623 	struct ill_s	*ilg_ill;	/* Where ilm is joined. No refhold */
624 	struct ilm_s	*ilg_ilm;	/* With ilm_refhold */
625 	uint_t		ilg_refcnt;
626 	mcast_record_t	ilg_fmode;	/* MODE_IS_INCLUDE/MODE_IS_EXCLUDE */
627 	slist_t		*ilg_filter;
628 	boolean_t	ilg_condemned;	/* Conceptually deleted */
629 } ilg_t;
630 
631 /*
632  * Multicast address list entry for ill.
633  * ilm_ill is used by IPv4 and IPv6
634  *
635  * The ilm state (and other multicast state on the ill) is protected by
636  * ill_mcast_lock. Operations that change state on both an ilg and ilm
637  * in addition use ill_mcast_serializer to ensure that we can't have
638  * interleaving between e.g., add and delete operations for the same conn_t,
639  * group, and ill. The ill_mcast_serializer is also used to ensure that
640  * multicast group joins do not occur on an interface that is in the process
641  * of joining an IPMP group.
642  *
643  * The comment below (and for other netstack_t references) refers
644  * to the fact that we only do netstack_hold in particular cases,
645  * such as the references from open endpoints (ill_t and conn_t's
646  * pointers). Internally within IP we rely on IP's ability to cleanup e.g.
647  * ire_t's when an ill goes away.
648  */
649 typedef struct ilm_s {
650 	in6_addr_t	ilm_v6addr;
651 	int		ilm_refcnt;
652 	uint_t		ilm_timer;	/* IGMP/MLD query resp timer, in msec */
653 	struct ilm_s	*ilm_next;	/* Linked list for each ill */
654 	uint_t		ilm_state;	/* state of the membership */
655 	struct ill_s	*ilm_ill;	/* Back pointer to ill - ill_ilm_cnt */
656 	zoneid_t	ilm_zoneid;
657 	int		ilm_no_ilg_cnt;	/* number of joins w/ no ilg */
658 	mcast_record_t	ilm_fmode;	/* MODE_IS_INCLUDE/MODE_IS_EXCLUDE */
659 	slist_t		*ilm_filter;	/* source filter list */
660 	slist_t		*ilm_pendsrcs;	/* relevant src addrs for pending req */
661 	rtx_state_t	ilm_rtx;	/* SCR retransmission state */
662 	ipaddr_t	ilm_ifaddr;	/* For IPv4 netstat */
663 	ip_stack_t	*ilm_ipst;	/* Does not have a netstack_hold */
664 } ilm_t;
665 
666 #define	ilm_addr	V4_PART_OF_V6(ilm_v6addr)
667 
668 /*
669  * Soft reference to an IPsec SA.
670  *
671  * On relative terms, conn's can be persistent (living as long as the
672  * processes which create them), while SA's are ephemeral (dying when
673  * they hit their time-based or byte-based lifetimes).
674  *
675  * We could hold a hard reference to an SA from an ipsec_latch_t,
676  * but this would cause expired SA's to linger for a potentially
677  * unbounded time.
678  *
679  * Instead, we remember the hash bucket number and bucket generation
680  * in addition to the pointer.  The bucket generation is incremented on
681  * each deletion.
682  */
683 typedef struct ipsa_ref_s
684 {
685 	struct ipsa_s	*ipsr_sa;
686 	struct isaf_s	*ipsr_bucket;
687 	uint64_t	ipsr_gen;
688 } ipsa_ref_t;
689 
690 /*
691  * IPsec "latching" state.
692  *
693  * In the presence of IPsec policy, fully-bound conn's bind a connection
694  * to more than just the 5-tuple, but also a specific IPsec action and
695  * identity-pair.
696  * The identity pair is accessed from both the receive and transmit side
697  * hence it is maintained in the ipsec_latch_t structure. conn_latch and
698  * ixa_ipsec_latch points to it.
699  * The policy and actions are stored in conn_latch_in_policy and
700  * conn_latch_in_action for the inbound side, and in ixa_ipsec_policy and
701  * ixa_ipsec_action for the transmit side.
702  *
703  * As an optimization, we also cache soft references to IPsec SA's in
704  * ip_xmit_attr_t so that we can fast-path around most of the work needed for
705  * outbound IPsec SA selection.
706  */
707 typedef struct ipsec_latch_s
708 {
709 	kmutex_t	ipl_lock;
710 	uint32_t	ipl_refcnt;
711 
712 	struct ipsid_s	*ipl_local_cid;
713 	struct ipsid_s	*ipl_remote_cid;
714 	unsigned int
715 			ipl_ids_latched : 1,
716 
717 			ipl_pad_to_bit_31 : 31;
718 } ipsec_latch_t;
719 
720 #define	IPLATCH_REFHOLD(ipl) { \
721 	atomic_add_32(&(ipl)->ipl_refcnt, 1);		\
722 	ASSERT((ipl)->ipl_refcnt != 0);			\
723 }
724 
725 #define	IPLATCH_REFRELE(ipl) {				\
726 	ASSERT((ipl)->ipl_refcnt != 0);				\
727 	membar_exit();						\
728 	if (atomic_add_32_nv(&(ipl)->ipl_refcnt, -1) == 0)	\
729 		iplatch_free(ipl);				\
730 }
731 
732 /*
733  * peer identity structure.
734  */
735 typedef struct conn_s conn_t;
736 
737 /*
738  * This is used to match an inbound/outbound datagram with policy.
739  */
740 typedef	struct ipsec_selector {
741 	in6_addr_t	ips_local_addr_v6;
742 	in6_addr_t	ips_remote_addr_v6;
743 	uint16_t	ips_local_port;
744 	uint16_t	ips_remote_port;
745 	uint8_t		ips_icmp_type;
746 	uint8_t		ips_icmp_code;
747 	uint8_t		ips_protocol;
748 	uint8_t		ips_isv4 : 1,
749 			ips_is_icmp_inv_acq: 1;
750 } ipsec_selector_t;
751 
752 /*
753  * Note that we put v4 addresses in the *first* 32-bit word of the
754  * selector rather than the last to simplify the prefix match/mask code
755  * in spd.c
756  */
757 #define	ips_local_addr_v4 ips_local_addr_v6.s6_addr32[0]
758 #define	ips_remote_addr_v4 ips_remote_addr_v6.s6_addr32[0]
759 
760 /* Values used in IP by IPSEC Code */
761 #define		IPSEC_OUTBOUND		B_TRUE
762 #define		IPSEC_INBOUND		B_FALSE
763 
764 /*
765  * There are two variants in policy failures. The packet may come in
766  * secure when not needed (IPSEC_POLICY_???_NOT_NEEDED) or it may not
767  * have the desired level of protection (IPSEC_POLICY_MISMATCH).
768  */
769 #define	IPSEC_POLICY_NOT_NEEDED		0
770 #define	IPSEC_POLICY_MISMATCH		1
771 #define	IPSEC_POLICY_AUTH_NOT_NEEDED	2
772 #define	IPSEC_POLICY_ENCR_NOT_NEEDED	3
773 #define	IPSEC_POLICY_SE_NOT_NEEDED	4
774 #define	IPSEC_POLICY_MAX		5	/* Always max + 1. */
775 
776 /*
777  * Check with IPSEC inbound policy if
778  *
779  * 1) per-socket policy is present - indicated by conn_in_enforce_policy.
780  * 2) Or if we have not cached policy on the conn and the global policy is
781  *    non-empty.
782  */
783 #define	CONN_INBOUND_POLICY_PRESENT(connp, ipss)	\
784 	((connp)->conn_in_enforce_policy ||		\
785 	(!((connp)->conn_policy_cached) && 		\
786 	(ipss)->ipsec_inbound_v4_policy_present))
787 
788 #define	CONN_INBOUND_POLICY_PRESENT_V6(connp, ipss)	\
789 	((connp)->conn_in_enforce_policy ||		\
790 	(!(connp)->conn_policy_cached &&		\
791 	(ipss)->ipsec_inbound_v6_policy_present))
792 
793 #define	CONN_OUTBOUND_POLICY_PRESENT(connp, ipss)	\
794 	((connp)->conn_out_enforce_policy ||		\
795 	(!((connp)->conn_policy_cached) &&		\
796 	(ipss)->ipsec_outbound_v4_policy_present))
797 
798 #define	CONN_OUTBOUND_POLICY_PRESENT_V6(connp, ipss)	\
799 	((connp)->conn_out_enforce_policy ||		\
800 	(!(connp)->conn_policy_cached &&		\
801 	(ipss)->ipsec_outbound_v6_policy_present))
802 
803 /*
804  * Information cached in IRE for upper layer protocol (ULP).
805  */
806 typedef struct iulp_s {
807 	boolean_t	iulp_set;	/* Is any metric set? */
808 	uint32_t	iulp_ssthresh;	/* Slow start threshold (TCP). */
809 	clock_t		iulp_rtt;	/* Guestimate in millisecs. */
810 	clock_t		iulp_rtt_sd;	/* Cached value of RTT variance. */
811 	uint32_t	iulp_spipe;	/* Send pipe size. */
812 	uint32_t	iulp_rpipe;	/* Receive pipe size. */
813 	uint32_t	iulp_rtomax;	/* Max round trip timeout. */
814 	uint32_t	iulp_sack;	/* Use SACK option (TCP)? */
815 	uint32_t	iulp_mtu;	/* Setable with routing sockets */
816 
817 	uint32_t
818 		iulp_tstamp_ok : 1,	/* Use timestamp option (TCP)? */
819 		iulp_wscale_ok : 1,	/* Use window scale option (TCP)? */
820 		iulp_ecn_ok : 1,	/* Enable ECN (for TCP)? */
821 		iulp_pmtud_ok : 1,	/* Enable PMTUd? */
822 
823 		/* These three are passed out by ip_set_destination */
824 		iulp_localnet: 1,	/* IRE_ONLINK */
825 		iulp_loopback: 1,	/* IRE_LOOPBACK */
826 		iulp_local: 1,		/* IRE_LOCAL */
827 
828 		iulp_not_used : 25;
829 } iulp_t;
830 
831 /*
832  * The conn drain list structure (idl_t), protected by idl_lock.  Each conn_t
833  * inserted in the list points back at this idl_t using conn_idl, and is
834  * chained by conn_drain_next and conn_drain_prev, which are also protected by
835  * idl_lock.  When flow control is relieved, either ip_wsrv() (STREAMS) or
836  * ill_flow_enable() (non-STREAMS) will call conn_drain().
837  *
838  * The conn drain list, idl_t, itself is part of tx cookie list structure.
839  * A tx cookie list points to a blocked Tx ring and contains the list of
840  * all conn's that are blocked due to the flow-controlled Tx ring (via
841  * the idl drain list). Note that a link can have multiple Tx rings. The
842  * drain list will store the conn's blocked due to Tx ring being flow
843  * controlled.
844  */
845 
846 typedef uintptr_t ip_mac_tx_cookie_t;
847 typedef	struct idl_s idl_t;
848 typedef	struct idl_tx_list_s idl_tx_list_t;
849 
850 struct idl_tx_list_s {
851 	ip_mac_tx_cookie_t	txl_cookie;
852 	kmutex_t		txl_lock;	/* Lock for this list */
853 	idl_t			*txl_drain_list;
854 	int			txl_drain_index;
855 };
856 
857 struct idl_s {
858 	conn_t		*idl_conn;		/* Head of drain list */
859 	kmutex_t	idl_lock;		/* Lock for this list */
860 	idl_tx_list_t	*idl_itl;
861 };
862 
863 /*
864  * Interface route structure which holds the necessary information to recreate
865  * routes that are tied to an interface i.e. have ire_ill set.
866  *
867  * These routes which were initially created via a routing socket or via the
868  * SIOCADDRT ioctl may be gateway routes (RTF_GATEWAY being set) or may be
869  * traditional interface routes.  When an ill comes back up after being
870  * down, this information will be used to recreate the routes.  These
871  * are part of an mblk_t chain that hangs off of the ILL (ill_saved_ire_mp).
872  */
873 typedef struct ifrt_s {
874 	ushort_t	ifrt_type;		/* Type of IRE */
875 	in6_addr_t	ifrt_v6addr;		/* Address IRE represents. */
876 	in6_addr_t	ifrt_v6gateway_addr;	/* Gateway if IRE_OFFLINK */
877 	in6_addr_t	ifrt_v6setsrc_addr;	/* Src addr if RTF_SETSRC */
878 	in6_addr_t	ifrt_v6mask;		/* Mask for matching IRE. */
879 	uint32_t	ifrt_flags;		/* flags related to route */
880 	iulp_t		ifrt_metrics;		/* Routing socket metrics */
881 	zoneid_t	ifrt_zoneid;		/* zoneid for route */
882 } ifrt_t;
883 
884 #define	ifrt_addr		V4_PART_OF_V6(ifrt_v6addr)
885 #define	ifrt_gateway_addr	V4_PART_OF_V6(ifrt_v6gateway_addr)
886 #define	ifrt_mask		V4_PART_OF_V6(ifrt_v6mask)
887 #define	ifrt_setsrc_addr	V4_PART_OF_V6(ifrt_v6setsrc_addr)
888 
889 /* Number of IP addresses that can be hosted on a physical interface */
890 #define	MAX_ADDRS_PER_IF	8192
891 /*
892  * Number of Source addresses to be considered for source address
893  * selection. Used by ipif_select_source_v4/v6.
894  */
895 #define	MAX_IPIF_SELECT_SOURCE	50
896 
897 #ifdef IP_DEBUG
898 /*
899  * Trace refholds and refreles for debugging.
900  */
901 #define	TR_STACK_DEPTH	14
902 typedef struct tr_buf_s {
903 	int	tr_depth;
904 	clock_t	tr_time;
905 	pc_t	tr_stack[TR_STACK_DEPTH];
906 } tr_buf_t;
907 
908 typedef struct th_trace_s {
909 	int		th_refcnt;
910 	uint_t		th_trace_lastref;
911 	kthread_t	*th_id;
912 #define	TR_BUF_MAX	38
913 	tr_buf_t	th_trbuf[TR_BUF_MAX];
914 } th_trace_t;
915 
916 typedef struct th_hash_s {
917 	list_node_t	thh_link;
918 	mod_hash_t	*thh_hash;
919 	ip_stack_t	*thh_ipst;
920 } th_hash_t;
921 #endif
922 
923 /* The following are ipif_state_flags */
924 #define	IPIF_CONDEMNED		0x1	/* The ipif is being removed */
925 #define	IPIF_CHANGING		0x2	/* A critcal ipif field is changing */
926 #define	IPIF_SET_LINKLOCAL	0x10	/* transient flag during bringup */
927 
928 /* IP interface structure, one per local address */
929 typedef struct ipif_s {
930 	struct	ipif_s	*ipif_next;
931 	struct	ill_s	*ipif_ill;	/* Back pointer to our ill */
932 	int	ipif_id;		/* Logical unit number */
933 	in6_addr_t ipif_v6lcl_addr;	/* Local IP address for this if. */
934 	in6_addr_t ipif_v6subnet;	/* Subnet prefix for this if. */
935 	in6_addr_t ipif_v6net_mask;	/* Net mask for this interface. */
936 	in6_addr_t ipif_v6brd_addr;	/* Broadcast addr for this interface. */
937 	in6_addr_t ipif_v6pp_dst_addr;	/* Point-to-point dest address. */
938 	uint64_t ipif_flags;		/* Interface flags. */
939 	uint_t	ipif_ire_type;		/* IRE_LOCAL or IRE_LOOPBACK */
940 
941 	/*
942 	 * The packet count in the ipif contain the sum of the
943 	 * packet counts in dead IRE_LOCAL/LOOPBACK for this ipif.
944 	 */
945 	uint_t	ipif_ib_pkt_count;	/* Inbound packets for our dead IREs */
946 
947 	/* Exclusive bit fields, protected by ipsq_t */
948 	unsigned int
949 		ipif_was_up : 1,	/* ipif was up before */
950 		ipif_addr_ready : 1,	/* DAD is done */
951 		ipif_was_dup : 1,	/* DAD had failed */
952 		ipif_added_nce : 1,	/* nce added for local address */
953 
954 		ipif_pad_to_31 : 28;
955 
956 	ilm_t	*ipif_allhosts_ilm;	/* For all-nodes join */
957 	ilm_t	*ipif_solmulti_ilm;	/* For IPv6 solicited multicast join */
958 
959 	uint_t	ipif_seqid;		/* unique index across all ills */
960 	uint_t	ipif_state_flags;	/* See IPIF_* flag defs above */
961 	uint_t	ipif_refcnt;		/* active consistent reader cnt */
962 
963 	zoneid_t ipif_zoneid;		/* zone ID number */
964 	timeout_id_t ipif_recovery_id;	/* Timer for DAD recovery */
965 	boolean_t ipif_trace_disable;	/* True when alloc fails */
966 	/*
967 	 * For an IPMP interface, ipif_bound_ill tracks the ill whose hardware
968 	 * information this ipif is associated with via ARP/NDP.  We can use
969 	 * an ill pointer (rather than an index) because only ills that are
970 	 * part of a group will be pointed to, and an ill cannot disappear
971 	 * while it's in a group.
972 	 */
973 	struct ill_s    *ipif_bound_ill;
974 	struct ipif_s   *ipif_bound_next; /* bound ipif chain */
975 	boolean_t	ipif_bound;	/* B_TRUE if we successfully bound */
976 
977 	struct ire_s	*ipif_ire_local; /* Our IRE_LOCAL or LOOPBACK */
978 	struct ire_s	*ipif_ire_if;	 /* Our IRE_INTERFACE */
979 } ipif_t;
980 
981 /*
982  * The following table lists the protection levels of the various members
983  * of the ipif_t. The following notation is used.
984  *
985  * Write once - Written to only once at the time of bringing up
986  * the interface and can be safely read after the bringup without any lock.
987  *
988  * ipsq - Need to execute in the ipsq to perform the indicated access.
989  *
990  * ill_lock - Need to hold this mutex to perform the indicated access.
991  *
992  * ill_g_lock - Need to hold this rw lock as reader/writer for read access or
993  * write access respectively.
994  *
995  * down ill - Written to only when the ill is down (i.e all ipifs are down)
996  * up ill - Read only when the ill is up (i.e. at least 1 ipif is up)
997  *
998  *		 Table of ipif_t members and their protection
999  *
1000  * ipif_next		ipsq + ill_lock +	ipsq OR ill_lock OR
1001  *			ill_g_lock		ill_g_lock
1002  * ipif_ill		ipsq + down ipif	write once
1003  * ipif_id		ipsq + down ipif	write once
1004  * ipif_v6lcl_addr	ipsq + down ipif	up ipif
1005  * ipif_v6subnet	ipsq + down ipif	up ipif
1006  * ipif_v6net_mask	ipsq + down ipif	up ipif
1007  *
1008  * ipif_v6brd_addr
1009  * ipif_v6pp_dst_addr
1010  * ipif_flags		ill_lock		ill_lock
1011  * ipif_ire_type	ipsq + down ill		up ill
1012  *
1013  * ipif_ib_pkt_count	Approx
1014  *
1015  * bit fields		ill_lock		ill_lock
1016  *
1017  * ipif_allhosts_ilm	ipsq			ipsq
1018  * ipif_solmulti_ilm	ipsq			ipsq
1019  *
1020  * ipif_seqid		ipsq			Write once
1021  *
1022  * ipif_state_flags	ill_lock		ill_lock
1023  * ipif_refcnt		ill_lock		ill_lock
1024  * ipif_bound_ill	ipsq + ipmp_lock	ipsq OR ipmp_lock
1025  * ipif_bound_next	ipsq			ipsq
1026  * ipif_bound		ipsq			ipsq
1027  *
1028  * ipif_ire_local	ipsq + ips_ill_g_lock	ipsq OR ips_ill_g_lock
1029  * ipif_ire_if		ipsq + ips_ill_g_lock	ipsq OR ips_ill_g_lock
1030  */
1031 
1032 /*
1033  * Return values from ip_laddr_verify_{v4,v6}
1034  */
1035 typedef enum { IPVL_UNICAST_UP, IPVL_UNICAST_DOWN, IPVL_MCAST, IPVL_BCAST,
1036 	    IPVL_BAD} ip_laddr_t;
1037 
1038 
1039 #define	IP_TR_HASH(tid)	((((uintptr_t)tid) >> 6) & (IP_TR_HASH_MAX - 1))
1040 
1041 #ifdef DEBUG
1042 #define	IPIF_TRACE_REF(ipif)	ipif_trace_ref(ipif)
1043 #define	ILL_TRACE_REF(ill)	ill_trace_ref(ill)
1044 #define	IPIF_UNTRACE_REF(ipif)	ipif_untrace_ref(ipif)
1045 #define	ILL_UNTRACE_REF(ill)	ill_untrace_ref(ill)
1046 #else
1047 #define	IPIF_TRACE_REF(ipif)
1048 #define	ILL_TRACE_REF(ill)
1049 #define	IPIF_UNTRACE_REF(ipif)
1050 #define	ILL_UNTRACE_REF(ill)
1051 #endif
1052 
1053 /* IPv4 compatibility macros */
1054 #define	ipif_lcl_addr		V4_PART_OF_V6(ipif_v6lcl_addr)
1055 #define	ipif_subnet		V4_PART_OF_V6(ipif_v6subnet)
1056 #define	ipif_net_mask		V4_PART_OF_V6(ipif_v6net_mask)
1057 #define	ipif_brd_addr		V4_PART_OF_V6(ipif_v6brd_addr)
1058 #define	ipif_pp_dst_addr	V4_PART_OF_V6(ipif_v6pp_dst_addr)
1059 
1060 /* Macros for easy backreferences to the ill. */
1061 #define	ipif_isv6		ipif_ill->ill_isv6
1062 
1063 #define	SIOCLIFADDR_NDX 112	/* ndx of SIOCLIFADDR in the ndx ioctl table */
1064 
1065 /*
1066  * mode value for ip_ioctl_finish for finishing an ioctl
1067  */
1068 #define	CONN_CLOSE	1		/* No mi_copy */
1069 #define	COPYOUT		2		/* do an mi_copyout if needed */
1070 #define	NO_COPYOUT	3		/* do an mi_copy_done */
1071 #define	IPI2MODE(ipi)	((ipi)->ipi_flags & IPI_GET_CMD ? COPYOUT : NO_COPYOUT)
1072 
1073 /*
1074  * The IP-MT design revolves around the serialization objects ipsq_t (IPSQ)
1075  * and ipxop_t (exclusive operation or "xop").  Becoming "writer" on an IPSQ
1076  * ensures that no other threads can become "writer" on any IPSQs sharing that
1077  * IPSQ's xop until the writer thread is done.
1078  *
1079  * Each phyint points to one IPSQ that remains fixed over the phyint's life.
1080  * Each IPSQ points to one xop that can change over the IPSQ's life.  If a
1081  * phyint is *not* in an IPMP group, then its IPSQ will refer to the IPSQ's
1082  * "own" xop (ipsq_ownxop).  If a phyint *is* part of an IPMP group, then its
1083  * IPSQ will refer to the "group" xop, which is shorthand for the xop of the
1084  * IPSQ of the IPMP meta-interface's phyint.  Thus, all phyints that are part
1085  * of the same IPMP group will have their IPSQ's point to the group xop, and
1086  * thus becoming "writer" on any phyint in the group will prevent any other
1087  * writer on any other phyint in the group.  All IPSQs sharing the same xop
1088  * are chained together through ipsq_next (in the degenerate common case,
1089  * ipsq_next simply refers to itself).  Note that the group xop is guaranteed
1090  * to exist at least as long as there are members in the group, since the IPMP
1091  * meta-interface can only be destroyed if the group is empty.
1092  *
1093  * Incoming exclusive operation requests are enqueued on the IPSQ they arrived
1094  * on rather than the xop.  This makes switching xop's (as would happen when a
1095  * phyint leaves an IPMP group) simple, because after the phyint leaves the
1096  * group, any operations enqueued on its IPSQ can be safely processed with
1097  * respect to its new xop, and any operations enqueued on the IPSQs of its
1098  * former group can be processed with respect to their existing group xop.
1099  * Even so, switching xops is a subtle dance; see ipsq_dq() for details.
1100  *
1101  * An IPSQ's "own" xop is embedded within the IPSQ itself since they have have
1102  * identical lifetimes, and because doing so simplifies pointer management.
1103  * While each phyint and IPSQ point to each other, it is not possible to free
1104  * the IPSQ when the phyint is freed, since we may still *inside* the IPSQ
1105  * when the phyint is being freed.  Thus, ipsq_phyint is set to NULL when the
1106  * phyint is freed, and the IPSQ free is later done in ipsq_exit().
1107  *
1108  * ipsq_t synchronization:	read			write
1109  *
1110  *	ipsq_xopq_mphead	ipx_lock		ipx_lock
1111  *	ipsq_xopq_mptail	ipx_lock		ipx_lock
1112  *	ipsq_xop_switch_mp	ipsq_lock		ipsq_lock
1113  *	ipsq_phyint		write once		write once
1114  *	ipsq_next		RW_READER ill_g_lock	RW_WRITER ill_g_lock
1115  *	ipsq_xop 		ipsq_lock or ipsq	ipsq_lock + ipsq
1116  *	ipsq_swxop		ipsq			ipsq
1117  * 	ipsq_ownxop		see ipxop_t		see ipxop_t
1118  *	ipsq_ipst		write once		write once
1119  *
1120  * ipxop_t synchronization:     read			write
1121  *
1122  *	ipx_writer  		ipx_lock		ipx_lock
1123  *	ipx_xop_queued		ipx_lock 		ipx_lock
1124  *	ipx_mphead		ipx_lock		ipx_lock
1125  *	ipx_mptail		ipx_lock		ipx_lock
1126  *	ipx_ipsq		write once		write once
1127  *	ips_ipsq_queued		ipx_lock		ipx_lock
1128  *	ipx_waitfor		ipsq or ipx_lock	ipsq + ipx_lock
1129  *	ipx_reentry_cnt		ipsq or ipx_lock	ipsq + ipx_lock
1130  *	ipx_current_done	ipsq			ipsq
1131  *	ipx_current_ioctl	ipsq			ipsq
1132  *	ipx_current_ipif	ipsq or ipx_lock	ipsq + ipx_lock
1133  *	ipx_pending_ipif	ipsq or ipx_lock	ipsq + ipx_lock
1134  *	ipx_pending_mp		ipsq or ipx_lock	ipsq + ipx_lock
1135  *	ipx_forced		ipsq			ipsq
1136  *	ipx_depth		ipsq			ipsq
1137  *	ipx_stack		ipsq			ipsq
1138  */
1139 typedef struct ipxop_s {
1140 	kmutex_t	ipx_lock;	/* see above */
1141 	kthread_t	*ipx_writer;  	/* current owner */
1142 	mblk_t		*ipx_mphead;	/* messages tied to this op */
1143 	mblk_t		*ipx_mptail;
1144 	struct ipsq_s	*ipx_ipsq;	/* associated ipsq */
1145 	boolean_t	ipx_ipsq_queued; /* ipsq using xop has queued op */
1146 	int		ipx_waitfor;	/* waiting; values encoded below */
1147 	int		ipx_reentry_cnt;
1148 	boolean_t	ipx_current_done;  /* is the current operation done? */
1149 	int		ipx_current_ioctl; /* current ioctl, or 0 if no ioctl */
1150 	ipif_t		*ipx_current_ipif; /* ipif for current op */
1151 	ipif_t		*ipx_pending_ipif; /* ipif for ipx_pending_mp */
1152 	mblk_t 		*ipx_pending_mp;   /* current ioctl mp while waiting */
1153 	boolean_t	ipx_forced; 			/* debugging aid */
1154 #ifdef DEBUG
1155 	int		ipx_depth;			/* debugging aid */
1156 #define	IPX_STACK_DEPTH	15
1157 	pc_t		ipx_stack[IPX_STACK_DEPTH];	/* debugging aid */
1158 #endif
1159 } ipxop_t;
1160 
1161 typedef struct ipsq_s {
1162 	kmutex_t ipsq_lock;		/* see above */
1163 	mblk_t	*ipsq_switch_mp;	/* op to handle right after switch */
1164 	mblk_t	*ipsq_xopq_mphead;	/* list of excl ops (mostly ioctls) */
1165 	mblk_t	*ipsq_xopq_mptail;
1166 	struct phyint	*ipsq_phyint;	/* associated phyint */
1167 	struct ipsq_s	*ipsq_next;	/* next ipsq sharing ipsq_xop */
1168 	struct ipxop_s	*ipsq_xop;	/* current xop synchronization info */
1169 	struct ipxop_s	*ipsq_swxop;	/* switch xop to on ipsq_exit() */
1170 	struct ipxop_s	ipsq_ownxop;	/* our own xop (may not be in-use) */
1171 	ip_stack_t	*ipsq_ipst;	/* does not have a netstack_hold */
1172 } ipsq_t;
1173 
1174 /*
1175  * ipx_waitfor values:
1176  */
1177 enum {
1178 	IPIF_DOWN = 1,	/* ipif_down() waiting for refcnts to drop */
1179 	ILL_DOWN,	/* ill_down() waiting for refcnts to drop */
1180 	IPIF_FREE,	/* ipif_free() waiting for refcnts to drop */
1181 	ILL_FREE	/* ill unplumb waiting for refcnts to drop */
1182 };
1183 
1184 /* Operation types for ipsq_try_enter() */
1185 #define	CUR_OP 0	/* request writer within current operation */
1186 #define	NEW_OP 1	/* request writer for a new operation */
1187 #define	SWITCH_OP 2	/* request writer once IPSQ XOP switches */
1188 
1189 /*
1190  * Kstats tracked on each IPMP meta-interface.  Order here must match
1191  * ipmp_kstats[] in ip/ipmp.c.
1192  */
1193 enum {
1194 	IPMP_KSTAT_OBYTES,	IPMP_KSTAT_OBYTES64,	IPMP_KSTAT_RBYTES,
1195 	IPMP_KSTAT_RBYTES64,	IPMP_KSTAT_OPACKETS,	IPMP_KSTAT_OPACKETS64,
1196 	IPMP_KSTAT_OERRORS,	IPMP_KSTAT_IPACKETS,	IPMP_KSTAT_IPACKETS64,
1197 	IPMP_KSTAT_IERRORS,	IPMP_KSTAT_MULTIRCV,	IPMP_KSTAT_MULTIXMT,
1198 	IPMP_KSTAT_BRDCSTRCV,	IPMP_KSTAT_BRDCSTXMT,	IPMP_KSTAT_LINK_UP,
1199 	IPMP_KSTAT_MAX		/* keep last */
1200 };
1201 
1202 /*
1203  * phyint represents state that is common to both IPv4 and IPv6 interfaces.
1204  * There is a separate ill_t representing IPv4 and IPv6 which has a
1205  * backpointer to the phyint structure for accessing common state.
1206  */
1207 typedef struct phyint {
1208 	struct ill_s	*phyint_illv4;
1209 	struct ill_s	*phyint_illv6;
1210 	uint_t		phyint_ifindex;		/* SIOCSLIFINDEX */
1211 	uint64_t	phyint_flags;
1212 	avl_node_t	phyint_avl_by_index;	/* avl tree by index */
1213 	avl_node_t	phyint_avl_by_name;	/* avl tree by name */
1214 	kmutex_t	phyint_lock;
1215 	struct ipsq_s	*phyint_ipsq;		/* back pointer to ipsq */
1216 	struct ipmp_grp_s *phyint_grp;		/* associated IPMP group */
1217 	char		phyint_name[LIFNAMSIZ];	/* physical interface name */
1218 	uint64_t	phyint_kstats0[IPMP_KSTAT_MAX];	/* baseline kstats */
1219 } phyint_t;
1220 
1221 #define	CACHE_ALIGN_SIZE 64
1222 #define	CACHE_ALIGN(align_struct)	P2ROUNDUP(sizeof (struct align_struct),\
1223 							CACHE_ALIGN_SIZE)
1224 struct _phyint_list_s_ {
1225 	avl_tree_t	phyint_list_avl_by_index;	/* avl tree by index */
1226 	avl_tree_t	phyint_list_avl_by_name;	/* avl tree by name */
1227 };
1228 
1229 typedef union phyint_list_u {
1230 	struct	_phyint_list_s_ phyint_list_s;
1231 	char	phyint_list_filler[CACHE_ALIGN(_phyint_list_s_)];
1232 } phyint_list_t;
1233 
1234 #define	phyint_list_avl_by_index	phyint_list_s.phyint_list_avl_by_index
1235 #define	phyint_list_avl_by_name		phyint_list_s.phyint_list_avl_by_name
1236 
1237 /*
1238  * Fragmentation hash bucket
1239  */
1240 typedef struct ipfb_s {
1241 	struct ipf_s	*ipfb_ipf;	/* List of ... */
1242 	size_t		ipfb_count;	/* Count of bytes used by frag(s) */
1243 	kmutex_t	ipfb_lock;	/* Protect all ipf in list */
1244 	uint_t		ipfb_frag_pkts; /* num of distinct fragmented pkts */
1245 } ipfb_t;
1246 
1247 /*
1248  * IRE bucket structure. Usually there is an array of such structures,
1249  * each pointing to a linked list of ires. irb_refcnt counts the number
1250  * of walkers of a given hash bucket. Usually the reference count is
1251  * bumped up if the walker wants no IRES to be DELETED while walking the
1252  * list. Bumping up does not PREVENT ADDITION. This allows walking a given
1253  * hash bucket without stumbling up on a free pointer.
1254  *
1255  * irb_t structures in ip_ftable are dynamically allocated and freed.
1256  * In order to identify the irb_t structures that can be safely kmem_free'd
1257  * we need to ensure that
1258  *  - the irb_refcnt is quiescent, indicating no other walkers,
1259  *  - no other threads or ire's are holding references to the irb,
1260  *	i.e., irb_nire == 0,
1261  *  - there are no active ire's in the bucket, i.e., irb_ire_cnt == 0
1262  */
1263 typedef struct irb {
1264 	struct ire_s	*irb_ire;	/* First ire in this bucket */
1265 					/* Should be first in this struct */
1266 	krwlock_t	irb_lock;	/* Protect this bucket */
1267 	uint_t		irb_refcnt;	/* Protected by irb_lock */
1268 	uchar_t		irb_marks;	/* CONDEMNED ires in this bucket ? */
1269 #define	IRB_MARK_CONDEMNED	0x0001	/* Contains some IRE_IS_CONDEMNED */
1270 #define	IRB_MARK_DYNAMIC	0x0002	/* Dynamically allocated */
1271 	/* Once IPv6 uses radix then IRB_MARK_DYNAMIC will be always be set */
1272 	uint_t		irb_ire_cnt;	/* Num of active IRE in this bucket */
1273 	int		irb_nire;	/* Num of ftable ire's that ref irb */
1274 	ip_stack_t	*irb_ipst;	/* Does not have a netstack_hold */
1275 } irb_t;
1276 
1277 /*
1278  * This is the structure used to store the multicast physical addresses
1279  * that an interface has joined.
1280  * The refcnt keeps track of the number of multicast IP addresses mapping
1281  * to a physical multicast address.
1282  */
1283 typedef struct multiphysaddr_s {
1284 	struct	multiphysaddr_s  *mpa_next;
1285 	char	mpa_addr[IP_MAX_HW_LEN];
1286 	int	mpa_refcnt;
1287 } multiphysaddr_t;
1288 
1289 #define	IRB2RT(irb)	(rt_t *)((caddr_t)(irb) - offsetof(rt_t, rt_irb))
1290 
1291 /* Forward declarations */
1292 struct dce_s;
1293 typedef struct dce_s dce_t;
1294 struct ire_s;
1295 typedef struct ire_s ire_t;
1296 struct ncec_s;
1297 typedef struct ncec_s ncec_t;
1298 struct nce_s;
1299 typedef struct nce_s nce_t;
1300 struct ip_recv_attr_s;
1301 typedef struct ip_recv_attr_s ip_recv_attr_t;
1302 struct ip_xmit_attr_s;
1303 typedef struct ip_xmit_attr_s ip_xmit_attr_t;
1304 
1305 struct tsol_ire_gw_secattr_s;
1306 typedef struct tsol_ire_gw_secattr_s tsol_ire_gw_secattr_t;
1307 
1308 /*
1309  * This is a structure for a one-element route cache that is passed
1310  * by reference between ip_input and ill_inputfn.
1311  */
1312 typedef struct {
1313 	ire_t		*rtc_ire;
1314 	ipaddr_t	rtc_ipaddr;
1315 	in6_addr_t	rtc_ip6addr;
1316 } rtc_t;
1317 
1318 /*
1319  * Note: Temporarily use 64 bits, and will probably go back to 32 bits after
1320  * more cleanup work is done.
1321  */
1322 typedef uint64_t iaflags_t;
1323 
1324 /* The ill input function pointer type */
1325 typedef void (*pfillinput_t)(mblk_t *, void *, void *, ip_recv_attr_t *,
1326     rtc_t *);
1327 
1328 /* The ire receive function pointer type */
1329 typedef void (*pfirerecv_t)(ire_t *, mblk_t *, void *, ip_recv_attr_t *);
1330 
1331 /* The ire send and postfrag function pointer types */
1332 typedef int (*pfiresend_t)(ire_t *, mblk_t *, void *,
1333     ip_xmit_attr_t *, uint32_t *);
1334 typedef int (*pfirepostfrag_t)(mblk_t *, nce_t *, iaflags_t, uint_t, uint32_t,
1335     zoneid_t, zoneid_t, uintptr_t *);
1336 
1337 
1338 #define	IP_V4_G_HEAD	0
1339 #define	IP_V6_G_HEAD	1
1340 
1341 #define	MAX_G_HEADS	2
1342 
1343 /*
1344  * unpadded ill_if structure
1345  */
1346 struct 	_ill_if_s_ {
1347 	union ill_if_u	*illif_next;
1348 	union ill_if_u	*illif_prev;
1349 	avl_tree_t	illif_avl_by_ppa;	/* AVL tree sorted on ppa */
1350 	vmem_t		*illif_ppa_arena;	/* ppa index space */
1351 	uint16_t	illif_mcast_v1;		/* hints for		  */
1352 	uint16_t	illif_mcast_v2;		/* [igmp|mld]_slowtimo	  */
1353 	int		illif_name_len;		/* name length */
1354 	char		illif_name[LIFNAMSIZ];	/* name of interface type */
1355 };
1356 
1357 /* cache aligned ill_if structure */
1358 typedef union 	ill_if_u {
1359 	struct  _ill_if_s_ ill_if_s;
1360 	char 	illif_filler[CACHE_ALIGN(_ill_if_s_)];
1361 } ill_if_t;
1362 
1363 #define	illif_next		ill_if_s.illif_next
1364 #define	illif_prev		ill_if_s.illif_prev
1365 #define	illif_avl_by_ppa	ill_if_s.illif_avl_by_ppa
1366 #define	illif_ppa_arena		ill_if_s.illif_ppa_arena
1367 #define	illif_mcast_v1		ill_if_s.illif_mcast_v1
1368 #define	illif_mcast_v2		ill_if_s.illif_mcast_v2
1369 #define	illif_name		ill_if_s.illif_name
1370 #define	illif_name_len		ill_if_s.illif_name_len
1371 
1372 typedef struct ill_walk_context_s {
1373 	int	ctx_current_list; /* current list being searched */
1374 	int	ctx_last_list;	 /* last list to search */
1375 } ill_walk_context_t;
1376 
1377 /*
1378  * ill_g_heads structure, one for IPV4 and one for IPV6
1379  */
1380 struct _ill_g_head_s_ {
1381 	ill_if_t	*ill_g_list_head;
1382 	ill_if_t	*ill_g_list_tail;
1383 };
1384 
1385 typedef union ill_g_head_u {
1386 	struct _ill_g_head_s_ ill_g_head_s;
1387 	char	ill_g_head_filler[CACHE_ALIGN(_ill_g_head_s_)];
1388 } ill_g_head_t;
1389 
1390 #define	ill_g_list_head	ill_g_head_s.ill_g_list_head
1391 #define	ill_g_list_tail	ill_g_head_s.ill_g_list_tail
1392 
1393 #define	IP_V4_ILL_G_LIST(ipst)	\
1394 	(ipst)->ips_ill_g_heads[IP_V4_G_HEAD].ill_g_list_head
1395 #define	IP_V6_ILL_G_LIST(ipst)	\
1396 	(ipst)->ips_ill_g_heads[IP_V6_G_HEAD].ill_g_list_head
1397 #define	IP_VX_ILL_G_LIST(i, ipst)	\
1398 	(ipst)->ips_ill_g_heads[i].ill_g_list_head
1399 
1400 #define	ILL_START_WALK_V4(ctx_ptr, ipst)	\
1401 	ill_first(IP_V4_G_HEAD, IP_V4_G_HEAD, ctx_ptr, ipst)
1402 #define	ILL_START_WALK_V6(ctx_ptr, ipst)	\
1403 	ill_first(IP_V6_G_HEAD, IP_V6_G_HEAD, ctx_ptr, ipst)
1404 #define	ILL_START_WALK_ALL(ctx_ptr, ipst)	\
1405 	ill_first(MAX_G_HEADS, MAX_G_HEADS, ctx_ptr, ipst)
1406 
1407 /*
1408  * Capabilities, possible flags for ill_capabilities.
1409  */
1410 #define	ILL_CAPAB_LSO		0x04		/* Large Send Offload */
1411 #define	ILL_CAPAB_HCKSUM	0x08		/* Hardware checksumming */
1412 #define	ILL_CAPAB_ZEROCOPY	0x10		/* Zero-copy */
1413 #define	ILL_CAPAB_DLD		0x20		/* DLD capabilities */
1414 #define	ILL_CAPAB_DLD_POLL	0x40		/* Polling */
1415 #define	ILL_CAPAB_DLD_DIRECT	0x80		/* Direct function call */
1416 
1417 /*
1418  * Per-ill Hardware Checksumming capbilities.
1419  */
1420 typedef struct ill_hcksum_capab_s ill_hcksum_capab_t;
1421 
1422 /*
1423  * Per-ill Zero-copy capabilities.
1424  */
1425 typedef struct ill_zerocopy_capab_s ill_zerocopy_capab_t;
1426 
1427 /*
1428  * DLD capbilities.
1429  */
1430 typedef struct ill_dld_capab_s ill_dld_capab_t;
1431 
1432 /*
1433  * Per-ill polling resource map.
1434  */
1435 typedef struct ill_rx_ring ill_rx_ring_t;
1436 
1437 /*
1438  * Per-ill Large Send Offload capabilities.
1439  */
1440 typedef struct ill_lso_capab_s ill_lso_capab_t;
1441 
1442 /* The following are ill_state_flags */
1443 #define	ILL_LL_SUBNET_PENDING	0x01	/* Waiting for DL_INFO_ACK from drv */
1444 #define	ILL_CONDEMNED		0x02	/* No more new ref's to the ILL */
1445 #define	ILL_DL_UNBIND_IN_PROGRESS	0x04	/* UNBIND_REQ is sent */
1446 /*
1447  * ILL_DOWN_IN_PROGRESS is set to ensure the following:
1448  * - no packets are sent to the driver after the DL_UNBIND_REQ is sent,
1449  * - no longstanding references will be acquired on objects that are being
1450  *   brought down.
1451  */
1452 #define	ILL_DOWN_IN_PROGRESS	0x08
1453 
1454 /* Is this an ILL whose source address is used by other ILL's ? */
1455 #define	IS_USESRC_ILL(ill)			\
1456 	(((ill)->ill_usesrc_ifindex == 0) &&	\
1457 	((ill)->ill_usesrc_grp_next != NULL))
1458 
1459 /* Is this a client/consumer of the usesrc ILL ? */
1460 #define	IS_USESRC_CLI_ILL(ill)			\
1461 	(((ill)->ill_usesrc_ifindex != 0) &&	\
1462 	((ill)->ill_usesrc_grp_next != NULL))
1463 
1464 /* Is this an virtual network interface (vni) ILL ? */
1465 #define	IS_VNI(ill)							\
1466 	(((ill)->ill_phyint->phyint_flags & (PHYI_LOOPBACK|PHYI_VIRTUAL)) == \
1467 	PHYI_VIRTUAL)
1468 
1469 /* Is this a loopback ILL? */
1470 #define	IS_LOOPBACK(ill) \
1471 	((ill)->ill_phyint->phyint_flags & PHYI_LOOPBACK)
1472 
1473 /* Is this an IPMP meta-interface ILL? */
1474 #define	IS_IPMP(ill)							\
1475 	((ill)->ill_phyint->phyint_flags & PHYI_IPMP)
1476 
1477 /* Is this ILL under an IPMP meta-interface? (aka "in a group?") */
1478 #define	IS_UNDER_IPMP(ill)						\
1479 	((ill)->ill_grp != NULL && !IS_IPMP(ill))
1480 
1481 /* Is ill1 in the same illgrp as ill2? */
1482 #define	IS_IN_SAME_ILLGRP(ill1, ill2)					\
1483 	((ill1)->ill_grp != NULL && ((ill1)->ill_grp == (ill2)->ill_grp))
1484 
1485 /* Is ill1 on the same LAN as ill2? */
1486 #define	IS_ON_SAME_LAN(ill1, ill2)					\
1487 	((ill1) == (ill2) || IS_IN_SAME_ILLGRP(ill1, ill2))
1488 
1489 #define	ILL_OTHER(ill)							\
1490 	((ill)->ill_isv6 ? (ill)->ill_phyint->phyint_illv4 :		\
1491 	    (ill)->ill_phyint->phyint_illv6)
1492 
1493 /*
1494  * IPMP group ILL state structure -- up to two per IPMP group (V4 and V6).
1495  * Created when the V4 and/or V6 IPMP meta-interface is I_PLINK'd.  It is
1496  * guaranteed to persist while there are interfaces of that type in the group.
1497  * In general, most fields are accessed outside of the IPSQ (e.g., in the
1498  * datapath), and thus use locks in addition to the IPSQ for protection.
1499  *
1500  * synchronization:		read			write
1501  *
1502  *	ig_if			ipsq or ill_g_lock	ipsq and ill_g_lock
1503  *	ig_actif		ipsq or ipmp_lock	ipsq and ipmp_lock
1504  *	ig_nactif		ipsq or ipmp_lock	ipsq and ipmp_lock
1505  *	ig_next_ill		ipsq or ipmp_lock	ipsq and ipmp_lock
1506  *	ig_ipmp_ill		write once		write once
1507  *	ig_cast_ill		ipsq or ipmp_lock	ipsq and ipmp_lock
1508  *	ig_arpent		ipsq			ipsq
1509  *	ig_mtu			ipsq			ipsq
1510  *	ig_mc_mtu		ipsq			ipsq
1511  */
1512 typedef struct ipmp_illgrp_s {
1513 	list_t		ig_if; 		/* list of all interfaces */
1514 	list_t		ig_actif;	/* list of active interfaces */
1515 	uint_t		ig_nactif;	/* number of active interfaces */
1516 	struct ill_s	*ig_next_ill;	/* next active interface to use */
1517 	struct ill_s	*ig_ipmp_ill;	/* backpointer to IPMP meta-interface */
1518 	struct ill_s	*ig_cast_ill;	/* nominated ill for multi/broadcast */
1519 	list_t		ig_arpent;	/* list of ARP entries */
1520 	uint_t		ig_mtu;		/* ig_ipmp_ill->ill_mtu */
1521 	uint_t		ig_mc_mtu;	/* ig_ipmp_ill->ill_mc_mtu */
1522 } ipmp_illgrp_t;
1523 
1524 /*
1525  * IPMP group state structure -- one per IPMP group.  Created when the
1526  * IPMP meta-interface is plumbed; it is guaranteed to persist while there
1527  * are interfaces in it.
1528  *
1529  * ipmp_grp_t synchronization:		read			write
1530  *
1531  *	gr_name				ipmp_lock		ipmp_lock
1532  *	gr_ifname			write once		write once
1533  *	gr_mactype			ipmp_lock		ipmp_lock
1534  *	gr_phyint			write once		write once
1535  *	gr_nif				ipmp_lock		ipmp_lock
1536  *	gr_nactif			ipsq			ipsq
1537  *	gr_v4				ipmp_lock		ipmp_lock
1538  *	gr_v6				ipmp_lock		ipmp_lock
1539  *	gr_nv4				ipmp_lock		ipmp_lock
1540  *	gr_nv6				ipmp_lock		ipmp_lock
1541  *	gr_pendv4			ipmp_lock		ipmp_lock
1542  *	gr_pendv6			ipmp_lock		ipmp_lock
1543  *	gr_linkdownmp			ipsq			ipsq
1544  *	gr_ksp				ipmp_lock		ipmp_lock
1545  *	gr_kstats0			atomic			atomic
1546  */
1547 typedef struct ipmp_grp_s {
1548 	char		gr_name[LIFGRNAMSIZ];	/* group name */
1549 	char		gr_ifname[LIFNAMSIZ];	/* interface name */
1550 	t_uscalar_t	gr_mactype;	/* DLPI mactype of group */
1551 	phyint_t	*gr_phyint;	/* IPMP group phyint */
1552 	uint_t		gr_nif;		/* number of interfaces in group */
1553 	uint_t		gr_nactif; 	/* number of active interfaces */
1554 	ipmp_illgrp_t	*gr_v4;		/* V4 group information */
1555 	ipmp_illgrp_t	*gr_v6;		/* V6 group information */
1556 	uint_t		gr_nv4;		/* number of ills in V4 group */
1557 	uint_t		gr_nv6;		/* number of ills in V6 group */
1558 	uint_t		gr_pendv4; 	/* number of pending ills in V4 group */
1559 	uint_t		gr_pendv6; 	/* number of pending ills in V6 group */
1560 	mblk_t		*gr_linkdownmp;	/* message used to bring link down */
1561 	kstat_t		*gr_ksp;	/* group kstat pointer */
1562 	uint64_t	gr_kstats0[IPMP_KSTAT_MAX]; /* baseline group kstats */
1563 } ipmp_grp_t;
1564 
1565 /*
1566  * IPMP ARP entry -- one per SIOCS*ARP entry tied to the group.  Used to keep
1567  * ARP up-to-date as the active set of interfaces in the group changes.
1568  */
1569 typedef struct ipmp_arpent_s {
1570 	ipaddr_t	ia_ipaddr; 	/* IP address for this entry */
1571 	boolean_t	ia_proxyarp; 	/* proxy ARP entry? */
1572 	boolean_t	ia_notified; 	/* ARP notified about this entry? */
1573 	list_node_t	ia_node; 	/* next ARP entry in list */
1574 	uint16_t	ia_flags;	/* nce_flags for the address */
1575 	size_t		ia_lladdr_len;
1576 	uchar_t		*ia_lladdr;
1577 } ipmp_arpent_t;
1578 
1579 struct arl_s;
1580 
1581 /*
1582  * Per-ill capabilities.
1583  */
1584 struct ill_hcksum_capab_s {
1585 	uint_t	ill_hcksum_version;	/* interface version */
1586 	uint_t	ill_hcksum_txflags;	/* capabilities on transmit */
1587 };
1588 
1589 struct ill_zerocopy_capab_s {
1590 	uint_t	ill_zerocopy_version;	/* interface version */
1591 	uint_t	ill_zerocopy_flags;	/* capabilities */
1592 };
1593 
1594 struct ill_lso_capab_s {
1595 	uint_t	ill_lso_flags;		/* capabilities */
1596 	uint_t	ill_lso_max;		/* maximum size of payload */
1597 };
1598 
1599 /*
1600  * IP Lower level Structure.
1601  * Instance data structure in ip_open when there is a device below us.
1602  */
1603 typedef struct ill_s {
1604 	pfillinput_t ill_inputfn;	/* Fast input function selector */
1605 	ill_if_t *ill_ifptr;		/* pointer to interface type */
1606 	queue_t	*ill_rq;		/* Read queue. */
1607 	queue_t	*ill_wq;		/* Write queue. */
1608 
1609 	int	ill_error;		/* Error value sent up by device. */
1610 
1611 	ipif_t	*ill_ipif;		/* Interface chain for this ILL. */
1612 
1613 	uint_t	ill_ipif_up_count;	/* Number of IPIFs currently up. */
1614 	uint_t	ill_max_frag;		/* Max IDU from DLPI. */
1615 	uint_t	ill_current_frag;	/* Current IDU from DLPI. */
1616 	uint_t	ill_mtu;		/* User-specified MTU; SIOCSLIFMTU */
1617 	uint_t	ill_mc_mtu;		/* MTU for multi/broadcast */
1618 	uint_t	ill_metric;		/* BSD if metric, for compatibility. */
1619 	char	*ill_name;		/* Our name. */
1620 	uint_t	ill_ipif_dup_count;	/* Number of duplicate addresses. */
1621 	uint_t	ill_name_length;	/* Name length, incl. terminator. */
1622 	uint_t	ill_net_type;		/* IRE_IF_RESOLVER/IRE_IF_NORESOLVER. */
1623 	/*
1624 	 * Physical Point of Attachment num.  If DLPI style 1 provider
1625 	 * then this is derived from the devname.
1626 	 */
1627 	uint_t	ill_ppa;
1628 	t_uscalar_t	ill_sap;
1629 	t_scalar_t	ill_sap_length;	/* Including sign (for position) */
1630 	uint_t	ill_phys_addr_length;	/* Excluding the sap. */
1631 	uint_t	ill_bcast_addr_length;	/* Only set when the DL provider */
1632 					/* supports broadcast. */
1633 	t_uscalar_t	ill_mactype;
1634 	uint8_t	*ill_frag_ptr;		/* Reassembly state. */
1635 	timeout_id_t ill_frag_timer_id; /* timeout id for the frag timer */
1636 	ipfb_t	*ill_frag_hash_tbl;	/* Fragment hash list head. */
1637 
1638 	krwlock_t ill_mcast_lock;	/* Protects multicast state */
1639 	kmutex_t ill_mcast_serializer;	/* Serialize across ilg and ilm state */
1640 	ilm_t	*ill_ilm;		/* Multicast membership for ill */
1641 	uint_t	ill_global_timer;	/* for IGMPv3/MLDv2 general queries */
1642 	int	ill_mcast_type;		/* type of router which is querier */
1643 					/* on this interface */
1644 	uint16_t ill_mcast_v1_time;	/* # slow timeouts since last v1 qry */
1645 	uint16_t ill_mcast_v2_time;	/* # slow timeouts since last v2 qry */
1646 	uint8_t	ill_mcast_v1_tset;	/* 1 => timer is set; 0 => not set */
1647 	uint8_t	ill_mcast_v2_tset;	/* 1 => timer is set; 0 => not set */
1648 
1649 	uint8_t	ill_mcast_rv;		/* IGMPv3/MLDv2 robustness variable */
1650 	int	ill_mcast_qi;		/* IGMPv3/MLDv2 query interval var */
1651 
1652 	/*
1653 	 * All non-NULL cells between 'ill_first_mp_to_free' and
1654 	 * 'ill_last_mp_to_free' are freed in ill_delete.
1655 	 */
1656 #define	ill_first_mp_to_free	ill_bcast_mp
1657 	mblk_t	*ill_bcast_mp;		/* DLPI header for broadcasts. */
1658 	mblk_t	*ill_unbind_mp;		/* unbind mp from ill_dl_up() */
1659 	mblk_t	*ill_promiscoff_mp;	/* for ill_leave_allmulti() */
1660 	mblk_t	*ill_dlpi_deferred;	/* b_next chain of control messages */
1661 	mblk_t	*ill_dest_addr_mp;	/* mblk which holds ill_dest_addr */
1662 	mblk_t	*ill_replumb_mp;	/* replumb mp from ill_replumb() */
1663 	mblk_t	*ill_phys_addr_mp;	/* mblk which holds ill_phys_addr */
1664 	mblk_t	*ill_mcast_deferred;	/* b_next chain of IGMP/MLD packets */
1665 #define	ill_last_mp_to_free	ill_mcast_deferred
1666 
1667 	cred_t	*ill_credp;		/* opener's credentials */
1668 	uint8_t	*ill_phys_addr;		/* ill_phys_addr_mp->b_rptr + off */
1669 	uint8_t *ill_dest_addr;		/* ill_dest_addr_mp->b_rptr + off */
1670 
1671 	uint_t	ill_state_flags;	/* see ILL_* flags above */
1672 
1673 	/* Following bit fields protected by ipsq_t */
1674 	uint_t
1675 		ill_needs_attach : 1,
1676 		ill_reserved : 1,
1677 		ill_isv6 : 1,
1678 		ill_dlpi_style_set : 1,
1679 
1680 		ill_ifname_pending : 1,
1681 		ill_logical_down : 1,
1682 		ill_dl_up : 1,
1683 		ill_up_ipifs : 1,
1684 
1685 		ill_note_link : 1,	/* supports link-up notification */
1686 		ill_capab_reneg : 1, /* capability renegotiation to be done */
1687 		ill_dld_capab_inprog : 1, /* direct dld capab call in prog */
1688 		ill_need_recover_multicast : 1,
1689 
1690 		ill_replumbing : 1,
1691 		ill_arl_dlpi_pending : 1,
1692 		ill_grp_pending : 1,
1693 
1694 		ill_pad_to_bit_31 : 17;
1695 
1696 	/* Following bit fields protected by ill_lock */
1697 	uint_t
1698 		ill_fragtimer_executing : 1,
1699 		ill_fragtimer_needrestart : 1,
1700 		ill_manual_token : 1,	/* system won't override ill_token */
1701 		/*
1702 		 * ill_manual_linklocal : system will not change the
1703 		 * linklocal whenever ill_token changes.
1704 		 */
1705 		ill_manual_linklocal : 1,
1706 
1707 		ill_manual_dst_linklocal : 1, /* same for pt-pt dst linklocal */
1708 
1709 		ill_pad_bit_31 : 27;
1710 
1711 	/*
1712 	 * Used in SIOCSIFMUXID and SIOCGIFMUXID for 'ifconfig unplumb'.
1713 	 */
1714 	int	ill_muxid;		/* muxid returned from plink */
1715 
1716 	/* Used for IP frag reassembly throttling on a per ILL basis.  */
1717 	uint_t	ill_ipf_gen;		/* Generation of next fragment queue */
1718 	uint_t	ill_frag_count;		/* Count of all reassembly mblk bytes */
1719 	uint_t	ill_frag_free_num_pkts;	 /* num of fragmented packets to free */
1720 	clock_t	ill_last_frag_clean_time; /* time when frag's were pruned */
1721 	int	ill_type;		/* From <net/if_types.h> */
1722 	uint_t	ill_dlpi_multicast_state;	/* See below IDS_* */
1723 	uint_t	ill_dlpi_fastpath_state;	/* See below IDS_* */
1724 
1725 	/*
1726 	 * Capabilities related fields.
1727 	 */
1728 	uint_t  ill_dlpi_capab_state;	/* State of capability query, IDCS_* */
1729 	uint_t	ill_capab_pending_cnt;
1730 	uint64_t ill_capabilities;	/* Enabled capabilities, ILL_CAPAB_* */
1731 	ill_hcksum_capab_t *ill_hcksum_capab; /* H/W cksumming capabilities */
1732 	ill_zerocopy_capab_t *ill_zerocopy_capab; /* Zero-copy capabilities */
1733 	ill_dld_capab_t *ill_dld_capab; /* DLD capabilities */
1734 	ill_lso_capab_t	*ill_lso_capab;	/* Large Segment Offload capabilities */
1735 	mblk_t	*ill_capab_reset_mp;	/* Preallocated mblk for capab reset */
1736 
1737 	uint8_t	ill_max_hops;	/* Maximum hops for any logical interface */
1738 	uint_t	ill_user_mtu;	/* User-specified MTU via SIOCSLIFLNKINFO */
1739 	uint32_t ill_reachable_time;	/* Value for ND algorithm in msec */
1740 	uint32_t ill_reachable_retrans_time; /* Value for ND algorithm msec */
1741 	uint_t	ill_max_buf;		/* Max # of req to buffer for ND */
1742 	in6_addr_t	ill_token;	/* IPv6 interface id */
1743 	in6_addr_t	ill_dest_token;	/* Destination IPv6 interface id */
1744 	uint_t		ill_token_length;
1745 	uint32_t	ill_xmit_count;		/* ndp max multicast xmits */
1746 	mib2_ipIfStatsEntry_t	*ill_ip_mib;	/* ver indep. interface mib */
1747 	mib2_ipv6IfIcmpEntry_t	*ill_icmp6_mib;	/* Per interface mib */
1748 
1749 	phyint_t		*ill_phyint;
1750 	uint64_t		ill_flags;
1751 
1752 	kmutex_t	ill_lock;	/* Please see table below */
1753 	/*
1754 	 * The ill_nd_lla* fields handle the link layer address option
1755 	 * from neighbor discovery. This is used for external IPv6
1756 	 * address resolution.
1757 	 */
1758 	mblk_t		*ill_nd_lla_mp;	/* mblk which holds ill_nd_lla */
1759 	uint8_t		*ill_nd_lla;	/* Link Layer Address */
1760 	uint_t		ill_nd_lla_len;	/* Link Layer Address length */
1761 	/*
1762 	 * We have 4 phys_addr_req's sent down. This field keeps track
1763 	 * of which one is pending.
1764 	 */
1765 	t_uscalar_t	ill_phys_addr_pend; /* which dl_phys_addr_req pending */
1766 	/*
1767 	 * Used to save errors that occur during plumbing
1768 	 */
1769 	uint_t		ill_ifname_pending_err;
1770 	avl_node_t	ill_avl_byppa; /* avl node based on ppa */
1771 	list_t		ill_nce; /* pointer to nce_s list */
1772 	uint_t		ill_refcnt;	/* active refcnt by threads */
1773 	uint_t		ill_ire_cnt;	/* ires associated with this ill */
1774 	kcondvar_t	ill_cv;
1775 	uint_t		ill_ncec_cnt;	/* ncecs associated with this ill */
1776 	uint_t		ill_nce_cnt;	/* nces associated with this ill */
1777 	uint_t		ill_waiters;	/* threads waiting in ipsq_enter */
1778 	/*
1779 	 * Contains the upper read queue pointer of the module immediately
1780 	 * beneath IP.  This field allows IP to validate sub-capability
1781 	 * acknowledgments coming up from downstream.
1782 	 */
1783 	queue_t		*ill_lmod_rq;	/* read queue pointer of module below */
1784 	uint_t		ill_lmod_cnt;	/* number of modules beneath IP */
1785 	ip_m_t		*ill_media;	/* media specific params/functions */
1786 	t_uscalar_t	ill_dlpi_pending; /* Last DLPI primitive issued */
1787 	uint_t		ill_usesrc_ifindex; /* use src addr from this ILL */
1788 	struct ill_s	*ill_usesrc_grp_next; /* Next ILL in the usesrc group */
1789 	boolean_t	ill_trace_disable;	/* True when alloc fails */
1790 	zoneid_t	ill_zoneid;
1791 	ip_stack_t	*ill_ipst;	/* Corresponds to a netstack_hold */
1792 	uint32_t	ill_dhcpinit;	/* IP_DHCPINIT_IFs for ill */
1793 	void		*ill_flownotify_mh; /* Tx flow ctl, mac cb handle */
1794 	uint_t		ill_ilm_cnt;    /* ilms referencing this ill */
1795 	uint_t		ill_ipallmulti_cnt; /* ip_join_allmulti() calls */
1796 	ilm_t		*ill_ipallmulti_ilm;
1797 
1798 	mblk_t		*ill_saved_ire_mp; /* Allocated for each extra IRE */
1799 					/* with ire_ill set so they can */
1800 					/* survive the ill going down and up. */
1801 	kmutex_t	ill_saved_ire_lock; /* Protects ill_saved_ire_mp, cnt */
1802 	uint_t		ill_saved_ire_cnt;	/* # entries */
1803 	struct arl_ill_common_s    *ill_common;
1804 	ire_t		*ill_ire_multicast; /* IRE_MULTICAST for ill */
1805 	clock_t		ill_defend_start;   /* start of 1 hour period */
1806 	uint_t		ill_defend_count;   /* # of announce/defends per ill */
1807 	/*
1808 	 * IPMP fields.
1809 	 */
1810 	ipmp_illgrp_t	*ill_grp;	/* IPMP group information */
1811 	list_node_t	ill_actnode; 	/* next active ill in group */
1812 	list_node_t	ill_grpnode;	/* next ill in group */
1813 	ipif_t		*ill_src_ipif;	/* source address selection rotor */
1814 	ipif_t		*ill_move_ipif;	/* ipif awaiting move to new ill */
1815 	boolean_t	ill_nom_cast;	/* nominated for mcast/bcast */
1816 	uint_t		ill_bound_cnt;	/* # of data addresses bound to ill */
1817 	ipif_t		*ill_bound_ipif; /* ipif chain bound to ill */
1818 	timeout_id_t	ill_refresh_tid; /* ill refresh retry timeout id */
1819 
1820 	uint32_t	ill_mrouter_cnt; /* mrouter allmulti joins */
1821 	uint32_t	ill_allowed_ips_cnt;
1822 	in6_addr_t	*ill_allowed_ips;
1823 
1824 	/* list of multicast physical addresses joined on this ill */
1825 	multiphysaddr_t *ill_mphysaddr_list;
1826 } ill_t;
1827 
1828 /*
1829  * ILL_FREE_OK() means that there are no incoming pointer references
1830  * to the ill.
1831  */
1832 #define	ILL_FREE_OK(ill)					\
1833 	((ill)->ill_ire_cnt == 0 && (ill)->ill_ilm_cnt == 0 &&	\
1834 	(ill)->ill_ncec_cnt == 0 && (ill)->ill_nce_cnt == 0)
1835 
1836 /*
1837  * An ipif/ill can be marked down only when the ire and ncec references
1838  * to that ipif/ill goes to zero. ILL_DOWN_OK() is a necessary condition
1839  * quiescence checks. See comments above IPIF_DOWN_OK for details
1840  * on why ires and nces are selectively considered for this macro.
1841  */
1842 #define	ILL_DOWN_OK(ill)					\
1843 	(ill->ill_ire_cnt == 0 && ill->ill_ncec_cnt == 0 &&	\
1844 	ill->ill_nce_cnt == 0)
1845 
1846 /*
1847  * The following table lists the protection levels of the various members
1848  * of the ill_t. Same notation as that used for ipif_t above is used.
1849  *
1850  *				Write			Read
1851  *
1852  * ill_ifptr			ill_g_lock + s		Write once
1853  * ill_rq			ipsq			Write once
1854  * ill_wq			ipsq			Write once
1855  *
1856  * ill_error			ipsq			None
1857  * ill_ipif			ill_g_lock + ipsq	ill_g_lock OR ipsq
1858  * ill_ipif_up_count		ill_lock + ipsq		ill_lock OR ipsq
1859  * ill_max_frag			ill_lock		ill_lock
1860  * ill_current_frag		ill_lock		ill_lock
1861  *
1862  * ill_name			ill_g_lock + ipsq	Write once
1863  * ill_name_length		ill_g_lock + ipsq	Write once
1864  * ill_ndd_name			ipsq			Write once
1865  * ill_net_type			ipsq			Write once
1866  * ill_ppa			ill_g_lock + ipsq	Write once
1867  * ill_sap			ipsq + down ill		Write once
1868  * ill_sap_length		ipsq + down ill		Write once
1869  * ill_phys_addr_length		ipsq + down ill		Write once
1870  *
1871  * ill_bcast_addr_length	ipsq			ipsq
1872  * ill_mactype			ipsq			ipsq
1873  * ill_frag_ptr			ipsq			ipsq
1874  *
1875  * ill_frag_timer_id		ill_lock		ill_lock
1876  * ill_frag_hash_tbl		ipsq			up ill
1877  * ill_ilm			ill_mcast_lock(WRITER)	ill_mcast_lock(READER)
1878  * ill_global_timer		ill_mcast_lock(WRITER)	ill_mcast_lock(READER)
1879  * ill_mcast_type		ill_mcast_lock(WRITER)	ill_mcast_lock(READER)
1880  * ill_mcast_v1_time		ill_mcast_lock(WRITER)	ill_mcast_lock(READER)
1881  * ill_mcast_v2_time		ill_mcast_lock(WRITER)	ill_mcast_lock(READER)
1882  * ill_mcast_v1_tset		ill_mcast_lock(WRITER)	ill_mcast_lock(READER)
1883  * ill_mcast_v2_tset		ill_mcast_lock(WRITER)	ill_mcast_lock(READER)
1884  * ill_mcast_rv			ill_mcast_lock(WRITER)	ill_mcast_lock(READER)
1885  * ill_mcast_qi			ill_mcast_lock(WRITER)	ill_mcast_lock(READER)
1886  *
1887  * ill_down_mp			ipsq			ipsq
1888  * ill_dlpi_deferred		ill_lock		ill_lock
1889  * ill_dlpi_pending		ipsq + ill_lock		ipsq or ill_lock or
1890  *							absence of ipsq writer.
1891  * ill_phys_addr_mp		ipsq + down ill		only when ill is up
1892  * ill_mcast_deferred		ill_lock		ill_lock
1893  * ill_phys_addr		ipsq + down ill		only when ill is up
1894  * ill_dest_addr_mp		ipsq + down ill		only when ill is up
1895  * ill_dest_addr		ipsq + down ill		only when ill is up
1896  *
1897  * ill_state_flags		ill_lock		ill_lock
1898  * exclusive bit flags		ipsq_t			ipsq_t
1899  * shared bit flags		ill_lock		ill_lock
1900  *
1901  * ill_muxid			ipsq			Not atomic
1902  *
1903  * ill_ipf_gen			Not atomic
1904  * ill_frag_count		atomics			atomics
1905  * ill_type			ipsq + down ill		only when ill is up
1906  * ill_dlpi_multicast_state	ill_lock		ill_lock
1907  * ill_dlpi_fastpath_state	ill_lock		ill_lock
1908  * ill_dlpi_capab_state		ipsq			ipsq
1909  * ill_max_hops			ipsq			Not atomic
1910  *
1911  * ill_mtu			ill_lock		None
1912  * ill_mc_mtu			ill_lock		None
1913  *
1914  * ill_user_mtu			ipsq + ill_lock		ill_lock
1915  * ill_reachable_time		ipsq + ill_lock		ill_lock
1916  * ill_reachable_retrans_time	ipsq + ill_lock		ill_lock
1917  * ill_max_buf			ipsq + ill_lock		ill_lock
1918  *
1919  * Next 2 fields need ill_lock because of the get ioctls. They should not
1920  * report partially updated results without executing in the ipsq.
1921  * ill_token			ipsq + ill_lock		ill_lock
1922  * ill_token_length		ipsq + ill_lock		ill_lock
1923  * ill_dest_token		ipsq + down ill		only when ill is up
1924  * ill_xmit_count		ipsq + down ill		write once
1925  * ill_ip6_mib			ipsq + down ill		only when ill is up
1926  * ill_icmp6_mib		ipsq + down ill		only when ill is up
1927  *
1928  * ill_phyint			ipsq, ill_g_lock, ill_lock	Any of them
1929  * ill_flags			ill_lock		ill_lock
1930  * ill_nd_lla_mp		ipsq + down ill		only when ill is up
1931  * ill_nd_lla			ipsq + down ill		only when ill is up
1932  * ill_nd_lla_len		ipsq + down ill		only when ill is up
1933  * ill_phys_addr_pend		ipsq + down ill		only when ill is up
1934  * ill_ifname_pending_err	ipsq			ipsq
1935  * ill_avl_byppa		ipsq, ill_g_lock	write once
1936  *
1937  * ill_fastpath_list		ill_lock		ill_lock
1938  * ill_refcnt			ill_lock		ill_lock
1939  * ill_ire_cnt			ill_lock		ill_lock
1940  * ill_cv			ill_lock		ill_lock
1941  * ill_ncec_cnt			ill_lock		ill_lock
1942  * ill_nce_cnt			ill_lock		ill_lock
1943  * ill_ilm_cnt			ill_lock		ill_lock
1944  * ill_src_ipif			ill_g_lock		ill_g_lock
1945  * ill_trace			ill_lock		ill_lock
1946  * ill_usesrc_grp_next		ill_g_usesrc_lock	ill_g_usesrc_lock
1947  * ill_dhcpinit			atomics			atomics
1948  * ill_flownotify_mh		write once		write once
1949  * ill_capab_pending_cnt	ipsq			ipsq
1950  * ill_ipallmulti_cnt		ill_lock		ill_lock
1951  * ill_ipallmulti_ilm		ill_lock		ill_lock
1952  * ill_saved_ire_mp		ill_saved_ire_lock	ill_saved_ire_lock
1953  * ill_saved_ire_cnt		ill_saved_ire_lock	ill_saved_ire_lock
1954  * ill_arl			???			???
1955  * ill_ire_multicast		ipsq + quiescent	none
1956  * ill_bound_ipif		ipsq			ipsq
1957  * ill_actnode			ipsq + ipmp_lock	ipsq OR ipmp_lock
1958  * ill_grpnode			ipsq + ill_g_lock	ipsq OR ill_g_lock
1959  * ill_src_ipif			ill_g_lock		ill_g_lock
1960  * ill_move_ipif		ipsq			ipsq
1961  * ill_nom_cast			ipsq			ipsq OR advisory
1962  * ill_refresh_tid		ill_lock		ill_lock
1963  * ill_grp (for IPMP ill)	write once		write once
1964  * ill_grp (for underlying ill)	ipsq + ill_g_lock	ipsq OR ill_g_lock
1965  * ill_grp_pending		ill_mcast_serializer	ill_mcast_serializer
1966  * ill_mrouter_cnt		atomics			atomics
1967  * ill_mphysaddr_list	ill_lock		ill_lock
1968  *
1969  * NOTE: It's OK to make heuristic decisions on an underlying interface
1970  *	 by using IS_UNDER_IPMP() or comparing ill_grp's raw pointer value.
1971  */
1972 
1973 /*
1974  * For ioctl restart mechanism see ip_reprocess_ioctl()
1975  */
1976 struct ip_ioctl_cmd_s;
1977 
1978 typedef	int (*ifunc_t)(ipif_t *, struct sockaddr_in *, queue_t *, mblk_t *,
1979     struct ip_ioctl_cmd_s *, void *);
1980 
1981 typedef struct ip_ioctl_cmd_s {
1982 	int	ipi_cmd;
1983 	size_t	ipi_copyin_size;
1984 	uint_t	ipi_flags;
1985 	uint_t	ipi_cmd_type;
1986 	ifunc_t	ipi_func;
1987 	ifunc_t	ipi_func_restart;
1988 } ip_ioctl_cmd_t;
1989 
1990 /*
1991  * ipi_cmd_type:
1992  *
1993  * IF_CMD		1	old style ifreq cmd
1994  * LIF_CMD		2	new style lifreq cmd
1995  * ARP_CMD		3	arpreq cmd
1996  * XARP_CMD		4	xarpreq cmd
1997  * MSFILT_CMD		5	multicast source filter cmd
1998  * MISC_CMD		6	misc cmd (not a more specific one above)
1999  */
2000 
2001 enum { IF_CMD = 1, LIF_CMD, ARP_CMD, XARP_CMD, MSFILT_CMD, MISC_CMD };
2002 
2003 #define	IPI_DONTCARE	0	/* For ioctl encoded values that don't matter */
2004 
2005 /* Flag values in ipi_flags */
2006 #define	IPI_PRIV	0x1	/* Root only command */
2007 #define	IPI_MODOK	0x2	/* Permitted on mod instance of IP */
2008 #define	IPI_WR		0x4	/* Need to grab writer access */
2009 #define	IPI_GET_CMD	0x8	/* branch to mi_copyout on success */
2010 /*	unused		0x10	*/
2011 #define	IPI_NULL_BCONT	0x20	/* ioctl has not data and hence no b_cont */
2012 
2013 extern ip_ioctl_cmd_t	ip_ndx_ioctl_table[];
2014 extern ip_ioctl_cmd_t	ip_misc_ioctl_table[];
2015 extern int ip_ndx_ioctl_count;
2016 extern int ip_misc_ioctl_count;
2017 
2018 /* Passed down by ARP to IP during I_PLINK/I_PUNLINK */
2019 typedef struct ipmx_s {
2020 	char	ipmx_name[LIFNAMSIZ];		/* if name */
2021 	uint_t
2022 		ipmx_arpdev_stream : 1,		/* This is the arp stream */
2023 		ipmx_notused : 31;
2024 } ipmx_t;
2025 
2026 /*
2027  * State for detecting if a driver supports certain features.
2028  * Support for DL_ENABMULTI_REQ uses ill_dlpi_multicast_state.
2029  * Support for DLPI M_DATA fastpath uses ill_dlpi_fastpath_state.
2030  */
2031 #define	IDS_UNKNOWN	0	/* No DLPI request sent */
2032 #define	IDS_INPROGRESS	1	/* DLPI request sent */
2033 #define	IDS_OK		2	/* DLPI request completed successfully */
2034 #define	IDS_FAILED	3	/* DLPI request failed */
2035 
2036 /* Support for DL_CAPABILITY_REQ uses ill_dlpi_capab_state. */
2037 enum {
2038 	IDCS_UNKNOWN,
2039 	IDCS_PROBE_SENT,
2040 	IDCS_OK,
2041 	IDCS_RESET_SENT,
2042 	IDCS_RENEG,
2043 	IDCS_FAILED
2044 };
2045 
2046 /* Extended NDP Management Structure */
2047 typedef struct ipndp_s {
2048 	ndgetf_t	ip_ndp_getf;
2049 	ndsetf_t	ip_ndp_setf;
2050 	caddr_t		ip_ndp_data;
2051 	char		*ip_ndp_name;
2052 } ipndp_t;
2053 
2054 /* IXA Notification types */
2055 typedef enum {
2056 	IXAN_LSO,	/* LSO capability change */
2057 	IXAN_PMTU,	/* PMTU change */
2058 	IXAN_ZCOPY	/* ZEROCOPY capability change */
2059 } ixa_notify_type_t;
2060 
2061 typedef uint_t ixa_notify_arg_t;
2062 
2063 typedef	void	(*ixa_notify_t)(void *, ip_xmit_attr_t *ixa, ixa_notify_type_t,
2064     ixa_notify_arg_t);
2065 
2066 /*
2067  * Attribute flags that are common to the transmit and receive attributes
2068  */
2069 #define	IAF_IS_IPV4		0x80000000	/* ipsec_*_v4 */
2070 #define	IAF_TRUSTED_ICMP	0x40000000	/* ipsec_*_icmp_loopback */
2071 #define	IAF_NO_LOOP_ZONEID_SET	0x20000000	/* Zone that shouldn't have */
2072 						/* a copy */
2073 #define	IAF_LOOPBACK_COPY	0x10000000	/* For multi and broadcast */
2074 
2075 #define	IAF_MASK		0xf0000000	/* Flags that are common */
2076 
2077 /*
2078  * Transmit side attributes used between the transport protocols and IP as
2079  * well as inside IP. It is also used to cache information in the conn_t i.e.
2080  * replaces conn_ire and the IPsec caching in the conn_t.
2081  */
2082 struct ip_xmit_attr_s {
2083 	iaflags_t	ixa_flags;	/* IXAF_*. See below */
2084 
2085 	uint32_t	ixa_free_flags;	/* IXA_FREE_*. See below */
2086 	uint32_t	ixa_refcnt;	/* Using atomics */
2087 
2088 	/*
2089 	 * Always initialized independently of ixa_flags settings.
2090 	 * Used by ip_xmit so we keep them up front for cache locality.
2091 	 */
2092 	uint32_t	ixa_xmit_hint;	/* For ECMP and GLD TX ring fanout */
2093 	uint_t		ixa_pktlen;	/* Always set. For frag and stats */
2094 	zoneid_t	ixa_zoneid;	/* Assumed always set */
2095 
2096 	/* Always set for conn_ip_output(); might be stale */
2097 	/*
2098 	 * Since TCP keeps the conn_t around past the process going away
2099 	 * we need to use the "notr" (e.g, ire_refhold_notr) for ixa_ire,
2100 	 * ixa_nce, and ixa_dce.
2101 	 */
2102 	ire_t		*ixa_ire;	/* Forwarding table entry */
2103 	uint_t		ixa_ire_generation;
2104 	nce_t		*ixa_nce;	/* Neighbor cache entry */
2105 	dce_t		*ixa_dce;	/* Destination cache entry */
2106 	uint_t		ixa_dce_generation;
2107 	uint_t		ixa_src_generation;	/* If IXAF_VERIFY_SOURCE */
2108 
2109 	uint32_t	ixa_src_preferences;	/* prefs for src addr select */
2110 	uint32_t	ixa_pmtu;		/* IXAF_VERIFY_PMTU */
2111 
2112 	/* Set by ULP if IXAF_VERIFY_PMTU; otherwise set by IP */
2113 	uint32_t	ixa_fragsize;
2114 
2115 	int8_t		ixa_use_min_mtu;	/* IXAF_USE_MIN_MTU values */
2116 
2117 	pfirepostfrag_t	ixa_postfragfn;		/* Set internally in IP */
2118 
2119 	in6_addr_t	ixa_nexthop_v6;		/* IXAF_NEXTHOP_SET */
2120 #define	ixa_nexthop_v4	V4_PART_OF_V6(ixa_nexthop_v6)
2121 
2122 	zoneid_t	ixa_no_loop_zoneid;	/* IXAF_NO_LOOP_ZONEID_SET */
2123 
2124 	uint_t		ixa_scopeid;		/* For IPv6 link-locals */
2125 
2126 	uint_t		ixa_broadcast_ttl;	/* IXAF_BROACAST_TTL_SET */
2127 
2128 	uint_t		ixa_multicast_ttl;	/* Assumed set for multicast */
2129 	uint_t		ixa_multicast_ifindex;	/* Assumed set for multicast */
2130 	ipaddr_t	ixa_multicast_ifaddr;	/* Assumed set for multicast */
2131 
2132 	int		ixa_raw_cksum_offset;	/* If IXAF_SET_RAW_CKSUM */
2133 
2134 	uint32_t	ixa_ident;		/* For IPv6 fragment header */
2135 
2136 	uint64_t	ixa_conn_id;		/* Used by DTrace */
2137 	/*
2138 	 * Cached LSO information.
2139 	 */
2140 	ill_lso_capab_t	ixa_lso_capab;		/* Valid when IXAF_LSO_CAPAB */
2141 
2142 	uint64_t	ixa_ipsec_policy_gen;	/* Generation from iph_gen */
2143 	/*
2144 	 * The following IPsec fields are only initialized when
2145 	 * IXAF_IPSEC_SECURE is set. Otherwise they contain garbage.
2146 	 */
2147 	ipsec_latch_t	*ixa_ipsec_latch;	/* Just the ids */
2148 	struct ipsa_s 	*ixa_ipsec_ah_sa;	/* Hard reference SA for AH */
2149 	struct ipsa_s 	*ixa_ipsec_esp_sa;	/* Hard reference SA for ESP */
2150 	struct ipsec_policy_s 	*ixa_ipsec_policy; /* why are we here? */
2151 	struct ipsec_action_s	*ixa_ipsec_action; /* For reflected packets */
2152 	ipsa_ref_t	ixa_ipsec_ref[2];	/* Soft reference to SA */
2153 						/* 0: ESP, 1: AH */
2154 
2155 	/*
2156 	 * The selectors here are potentially different than the SPD rule's
2157 	 * selectors, and we need to have both available for IKEv2.
2158 	 *
2159 	 * NOTE: "Source" and "Dest" are w.r.t. outbound datagrams.  Ports can
2160 	 *	 be zero, and the protocol number is needed to make the ports
2161 	 *	 significant.
2162 	 */
2163 	uint16_t ixa_ipsec_src_port;	/* Source port number of d-gram. */
2164 	uint16_t ixa_ipsec_dst_port;	/* Destination port number of d-gram. */
2165 	uint8_t  ixa_ipsec_icmp_type;	/* ICMP type of d-gram */
2166 	uint8_t  ixa_ipsec_icmp_code;	/* ICMP code of d-gram */
2167 
2168 	sa_family_t ixa_ipsec_inaf;	/* Inner address family */
2169 #define	IXA_MAX_ADDRLEN 4	/* Max addr len. (in 32-bit words) */
2170 	uint32_t ixa_ipsec_insrc[IXA_MAX_ADDRLEN];	/* Inner src address */
2171 	uint32_t ixa_ipsec_indst[IXA_MAX_ADDRLEN];	/* Inner dest address */
2172 	uint8_t  ixa_ipsec_insrcpfx;	/* Inner source prefix */
2173 	uint8_t  ixa_ipsec_indstpfx;	/* Inner destination prefix */
2174 
2175 	uint8_t ixa_ipsec_proto;	/* IP protocol number for d-gram. */
2176 
2177 	/* Always initialized independently of ixa_flags settings */
2178 	uint_t		ixa_ifindex;	/* Assumed always set */
2179 	uint16_t	ixa_ip_hdr_length; /* Points to ULP header */
2180 	uint8_t		ixa_protocol;	/* Protocol number for ULP cksum */
2181 	ts_label_t	*ixa_tsl;	/* Always set. NULL if not TX */
2182 	ip_stack_t	*ixa_ipst;	/* Always set */
2183 	uint32_t	ixa_extra_ident; /* Set if LSO */
2184 	cred_t		*ixa_cred;	/* For getpeerucred */
2185 	pid_t		ixa_cpid;	/* For getpeerucred */
2186 
2187 #ifdef DEBUG
2188 	kthread_t	*ixa_curthread;	/* For serialization assert */
2189 #endif
2190 	squeue_t	*ixa_sqp;	/* Set from conn_sqp as a hint */
2191 	uintptr_t	ixa_cookie;	/* cookie to use for tx flow control */
2192 
2193 	/*
2194 	 * Must be set by ULP if any of IXAF_VERIFY_LSO, IXAF_VERIFY_PMTU,
2195 	 * or IXAF_VERIFY_ZCOPY is set.
2196 	 */
2197 	ixa_notify_t	ixa_notify;	/* Registered upcall notify function */
2198 	void		*ixa_notify_cookie; /* ULP cookie for ixa_notify */
2199 
2200 	uint_t		ixa_tcpcleanup;	/* Used by conn_ixa_cleanup */
2201 };
2202 
2203 /*
2204  * Flags to indicate which transmit attributes are set.
2205  * Split into "xxx_SET" ones which indicate that the "xxx" field it set, and
2206  * single flags.
2207  */
2208 #define	IXAF_REACH_CONF		0x00000001	/* Reachability confirmation */
2209 #define	IXAF_BROADCAST_TTL_SET	0x00000002	/* ixa_broadcast_ttl valid */
2210 #define	IXAF_SET_SOURCE		0x00000004	/* Replace if broadcast */
2211 #define	IXAF_USE_MIN_MTU	0x00000008	/* IPV6_USE_MIN_MTU */
2212 
2213 #define	IXAF_DONTFRAG		0x00000010	/* IP*_DONTFRAG */
2214 #define	IXAF_VERIFY_PMTU	0x00000020	/* ixa_pmtu/ixa_fragsize set */
2215 #define	IXAF_PMTU_DISCOVERY	0x00000040	/* Create/use PMTU state */
2216 #define	IXAF_MULTICAST_LOOP	0x00000080	/* IP_MULTICAST_LOOP */
2217 
2218 #define	IXAF_IPSEC_SECURE	0x00000100	/* Need IPsec processing */
2219 #define	IXAF_UCRED_TSL		0x00000200	/* ixa_tsl from SCM_UCRED */
2220 #define	IXAF_DONTROUTE		0x00000400	/* SO_DONTROUTE */
2221 #define	IXAF_NO_IPSEC		0x00000800	/* Ignore policy */
2222 
2223 #define	IXAF_PMTU_TOO_SMALL	0x00001000	/* PMTU too small */
2224 #define	IXAF_SET_ULP_CKSUM	0x00002000	/* Calculate ULP checksum */
2225 #define	IXAF_VERIFY_SOURCE	0x00004000	/* Check that source is ok */
2226 #define	IXAF_NEXTHOP_SET	0x00008000	/* ixa_nexthop set */
2227 
2228 #define	IXAF_PMTU_IPV4_DF	0x00010000	/* Set IPv4 DF */
2229 #define	IXAF_NO_DEV_FLOW_CTL	0x00020000	/* Protocol needs no flow ctl */
2230 #define	IXAF_NO_TTL_CHANGE	0x00040000	/* Internal to IP */
2231 #define	IXAF_IPV6_ADD_FRAGHDR	0x00080000	/* Add fragment header */
2232 
2233 #define	IXAF_IPSEC_TUNNEL	0x00100000	/* Tunnel mode */
2234 #define	IXAF_NO_PFHOOK		0x00200000	/* Skip xmit pfhook */
2235 #define	IXAF_NO_TRACE		0x00400000	/* When back from ARP/ND */
2236 #define	IXAF_SCOPEID_SET	0x00800000	/* ixa_scopeid set */
2237 
2238 #define	IXAF_MULTIRT_MULTICAST	0x01000000	/* MULTIRT for multicast */
2239 #define	IXAF_NO_HW_CKSUM	0x02000000	/* Force software cksum */
2240 #define	IXAF_SET_RAW_CKSUM	0x04000000	/* Use ixa_raw_cksum_offset */
2241 #define	IXAF_IPSEC_GLOBAL_POLICY 0x08000000	/* Policy came from global */
2242 
2243 /* Note the following uses bits 0x10000000 through 0x80000000 */
2244 #define	IXAF_IS_IPV4		IAF_IS_IPV4
2245 #define	IXAF_TRUSTED_ICMP	IAF_TRUSTED_ICMP
2246 #define	IXAF_NO_LOOP_ZONEID_SET	IAF_NO_LOOP_ZONEID_SET
2247 #define	IXAF_LOOPBACK_COPY	IAF_LOOPBACK_COPY
2248 
2249 /* Note: use the upper 32 bits */
2250 #define	IXAF_VERIFY_LSO		0x100000000	/* Check LSO capability */
2251 #define	IXAF_LSO_CAPAB		0x200000000	/* Capable of LSO */
2252 #define	IXAF_VERIFY_ZCOPY	0x400000000	/* Check Zero Copy capability */
2253 #define	IXAF_ZCOPY_CAPAB	0x800000000	/* Capable of ZEROCOPY */
2254 
2255 /*
2256  * The normal flags for sending packets e.g., icmp errors
2257  */
2258 #define	IXAF_BASIC_SIMPLE_V4	\
2259 	(IXAF_SET_ULP_CKSUM | IXAF_IS_IPV4 | IXAF_VERIFY_SOURCE)
2260 #define	IXAF_BASIC_SIMPLE_V6	(IXAF_SET_ULP_CKSUM | IXAF_VERIFY_SOURCE)
2261 
2262 /*
2263  * Normally these fields do not have a hold. But in some cases they do, for
2264  * instance when we've gone through ip_*_attr_to/from_mblk.
2265  * We use ixa_free_flags to indicate that they have a hold and need to be
2266  * released on cleanup.
2267  */
2268 #define	IXA_FREE_CRED		0x00000001	/* ixa_cred needs to be rele */
2269 #define	IXA_FREE_TSL		0x00000002	/* ixa_tsl needs to be rele */
2270 
2271 /*
2272  * Trivial state machine used to synchronize IXA cleanup for TCP connections.
2273  * See conn_ixa_cleanup().
2274  */
2275 #define	IXATC_IDLE		0x00000000
2276 #define	IXATC_INPROGRESS	0x00000001
2277 #define	IXATC_COMPLETE		0x00000002
2278 
2279 /*
2280  * Simplistic way to set the ixa_xmit_hint for locally generated traffic
2281  * and forwarded traffic. The shift amount are based on the size of the
2282  * structs to discard the low order bits which don't have much if any variation
2283  * (coloring in kmem_cache_alloc might provide some variation).
2284  *
2285  * Basing the locally generated hint on the address of the conn_t means that
2286  * the packets from the same socket/connection do not get reordered.
2287  * Basing the hint for forwarded traffic on the ill_ring_t means that
2288  * packets from the same NIC+ring are likely to use the same outbound ring
2289  * hence we get low contention on the ring in the transmitting driver.
2290  */
2291 #define	CONN_TO_XMIT_HINT(connp)	((uint32_t)(((uintptr_t)connp) >> 11))
2292 #define	ILL_RING_TO_XMIT_HINT(ring)	((uint32_t)(((uintptr_t)ring) >> 7))
2293 
2294 /*
2295  * IP set Destination Flags used by function ip_set_destination,
2296  * ip_attr_connect, and conn_connect.
2297  */
2298 #define	IPDF_ALLOW_MCBC		0x1	/* Allow multi/broadcast */
2299 #define	IPDF_VERIFY_DST		0x2	/* Verify destination addr */
2300 #define	IPDF_SELECT_SRC		0x4	/* Select source address */
2301 #define	IPDF_LSO		0x8	/* Try LSO */
2302 #define	IPDF_IPSEC		0x10	/* Set IPsec policy */
2303 #define	IPDF_ZONE_IS_GLOBAL	0x20	/* From conn_zone_is_global */
2304 #define	IPDF_ZCOPY		0x40	/* Try ZEROCOPY */
2305 #define	IPDF_UNIQUE_DCE		0x80	/* Get a per-destination DCE */
2306 
2307 /*
2308  * Receive side attributes used between the transport protocols and IP as
2309  * well as inside IP.
2310  */
2311 struct ip_recv_attr_s {
2312 	iaflags_t	ira_flags;	/* See below */
2313 
2314 	uint32_t	ira_free_flags;	/* IRA_FREE_*. See below */
2315 
2316 	/*
2317 	 * This is a hint for TCP SYN packets.
2318 	 * Always initialized independently of ira_flags settings
2319 	 */
2320 	squeue_t	*ira_sqp;
2321 	ill_rx_ring_t	*ira_ring;	/* Internal to IP */
2322 
2323 	/* For ip_accept_tcp when IRAF_TARGET_SQP is set */
2324 	squeue_t	*ira_target_sqp;
2325 	mblk_t		*ira_target_sqp_mp;
2326 
2327 	/* Always initialized independently of ira_flags settings */
2328 	uint32_t	ira_xmit_hint;	/* For ECMP and GLD TX ring fanout */
2329 	zoneid_t	ira_zoneid;	/* ALL_ZONES unless local delivery */
2330 	uint_t		ira_pktlen;	/* Always set. For frag and stats */
2331 	uint16_t	ira_ip_hdr_length; /* Points to ULP header */
2332 	uint8_t		ira_protocol;	/* Protocol number for ULP cksum */
2333 	uint_t		ira_rifindex;	/* Received ifindex */
2334 	uint_t		ira_ruifindex;	/* Received upper ifindex */
2335 	ts_label_t	*ira_tsl;	/* Always set. NULL if not TX */
2336 	/*
2337 	 * ira_rill and ira_ill is set inside IP, but not when conn_recv is
2338 	 * called; ULPs should use ira_ruifindex instead.
2339 	 */
2340 	ill_t		*ira_rill;	/* ill where packet came */
2341 	ill_t		*ira_ill;	/* ill where IP address hosted */
2342 	cred_t		*ira_cred;	/* For getpeerucred */
2343 	pid_t		ira_cpid;	/* For getpeerucred */
2344 
2345 	/* Used when IRAF_VERIFIED_SRC is set; this source was ok */
2346 	ipaddr_t	ira_verified_src;
2347 
2348 	/*
2349 	 * The following IPsec fields are only initialized when
2350 	 * IRAF_IPSEC_SECURE is set. Otherwise they contain garbage.
2351 	 */
2352 	struct ipsec_action_s *ira_ipsec_action; /* how we made it in.. */
2353 	struct ipsa_s 	*ira_ipsec_ah_sa;	/* SA for AH */
2354 	struct ipsa_s 	*ira_ipsec_esp_sa;	/* SA for ESP */
2355 
2356 	ipaddr_t	ira_mroute_tunnel;	/* IRAF_MROUTE_TUNNEL_SET */
2357 
2358 	zoneid_t	ira_no_loop_zoneid;	/* IRAF_NO_LOOP_ZONEID_SET */
2359 
2360 	uint32_t	ira_esp_udp_ports;	/* IRAF_ESP_UDP_PORTS */
2361 
2362 	/*
2363 	 * For IP_RECVSLLA and ip_ndp_conflict/find_solicitation.
2364 	 * Same size as max for sockaddr_dl
2365 	 */
2366 #define	IRA_L2SRC_SIZE	244
2367 	uint8_t		ira_l2src[IRA_L2SRC_SIZE];	/* If IRAF_L2SRC_SET */
2368 
2369 	/*
2370 	 * Local handle that we use to do lazy setting of ira_l2src.
2371 	 * We defer setting l2src until needed but we do before any
2372 	 * ip_input pullupmsg or copymsg.
2373 	 */
2374 	struct mac_header_info_s *ira_mhip;	/* Could be NULL */
2375 };
2376 
2377 /*
2378  * Flags to indicate which receive attributes are set.
2379  */
2380 #define	IRAF_SYSTEM_LABELED	0x00000001	/* is_system_labeled() */
2381 #define	IRAF_IPV4_OPTIONS	0x00000002	/* Performance */
2382 #define	IRAF_MULTICAST		0x00000004	/* Was multicast at L3 */
2383 #define	IRAF_BROADCAST		0x00000008	/* Was broadcast at L3 */
2384 #define	IRAF_MULTIBROADCAST	(IRAF_MULTICAST|IRAF_BROADCAST)
2385 
2386 #define	IRAF_LOOPBACK		0x00000010	/* Looped back by IP */
2387 #define	IRAF_VERIFY_IP_CKSUM	0x00000020	/* Need to verify IP */
2388 #define	IRAF_VERIFY_ULP_CKSUM	0x00000040	/* Need to verify TCP,UDP,etc */
2389 #define	IRAF_SCTP_CSUM_ERR	0x00000080	/* sctp pkt has failed chksum */
2390 
2391 #define	IRAF_IPSEC_SECURE	0x00000100	/* Passed AH and/or ESP */
2392 #define	IRAF_DHCP_UNICAST	0x00000200
2393 #define	IRAF_IPSEC_DECAPS	0x00000400	/* Was packet decapsulated */
2394 					/* from a matching inner packet? */
2395 #define	IRAF_TARGET_SQP		0x00000800	/* ira_target_sqp is set */
2396 #define	IRAF_VERIFIED_SRC	0x00001000	/* ira_verified_src set */
2397 #define	IRAF_RSVP		0x00002000	/* RSVP packet for rsvpd */
2398 #define	IRAF_MROUTE_TUNNEL_SET	0x00004000	/* From ip_mroute_decap */
2399 #define	IRAF_PIM_REGISTER	0x00008000	/* From register_mforward */
2400 
2401 #define	IRAF_TX_MAC_EXEMPTABLE	0x00010000	/* Allow MAC_EXEMPT readdown */
2402 #define	IRAF_TX_SHARED_ADDR	0x00020000	/* Arrived on ALL_ZONES addr */
2403 #define	IRAF_ESP_UDP_PORTS	0x00040000	/* NAT-traversal packet */
2404 #define	IRAF_NO_HW_CKSUM	0x00080000	/* Force software cksum */
2405 
2406 #define	IRAF_ICMP_ERROR		0x00100000	/* Send to conn_recvicmp */
2407 #define	IRAF_ROUTER_ALERT	0x00200000	/* IPv6 router alert */
2408 #define	IRAF_L2SRC_SET		0x00400000	/* ira_l2src has been set */
2409 #define	IRAF_L2SRC_LOOPBACK	0x00800000	/* Came from us */
2410 
2411 #define	IRAF_L2DST_MULTICAST	0x01000000	/* Multicast at L2 */
2412 #define	IRAF_L2DST_BROADCAST	0x02000000	/* Broadcast at L2 */
2413 /* Unused 0x04000000 */
2414 /* Unused 0x08000000 */
2415 
2416 /* Below starts with 0x10000000 */
2417 #define	IRAF_IS_IPV4		IAF_IS_IPV4
2418 #define	IRAF_TRUSTED_ICMP	IAF_TRUSTED_ICMP
2419 #define	IRAF_NO_LOOP_ZONEID_SET	IAF_NO_LOOP_ZONEID_SET
2420 #define	IRAF_LOOPBACK_COPY	IAF_LOOPBACK_COPY
2421 
2422 /*
2423  * Normally these fields do not have a hold. But in some cases they do, for
2424  * instance when we've gone through ip_*_attr_to/from_mblk.
2425  * We use ira_free_flags to indicate that they have a hold and need to be
2426  * released on cleanup.
2427  */
2428 #define	IRA_FREE_CRED		0x00000001	/* ira_cred needs to be rele */
2429 #define	IRA_FREE_TSL		0x00000002	/* ira_tsl needs to be rele */
2430 
2431 /*
2432  * Optional destination cache entry for path MTU information,
2433  * and ULP metrics.
2434  */
2435 struct dce_s {
2436 	uint_t		dce_generation;	/* Changed since cached? */
2437 	uint_t		dce_flags;	/* See below */
2438 	uint_t		dce_ipversion;	/* IPv4/IPv6 version */
2439 	uint32_t	dce_pmtu;	/* Path MTU if DCEF_PMTU */
2440 	uint32_t	dce_ident;	/* Per destination IP ident. */
2441 	iulp_t		dce_uinfo;	/* Metrics if DCEF_UINFO */
2442 
2443 	struct dce_s	*dce_next;
2444 	struct dce_s	**dce_ptpn;
2445 	struct dcb_s	*dce_bucket;
2446 
2447 	union {
2448 		in6_addr_t	dceu_v6addr;
2449 		ipaddr_t	dceu_v4addr;
2450 	} dce_u;
2451 #define	dce_v4addr	dce_u.dceu_v4addr
2452 #define	dce_v6addr	dce_u.dceu_v6addr
2453 	/* Note that for IPv6+IPMP we use the ifindex for the upper interface */
2454 	uint_t		dce_ifindex;	/* For IPv6 link-locals */
2455 
2456 	kmutex_t	dce_lock;
2457 	uint_t		dce_refcnt;
2458 	uint64_t	dce_last_change_time;	/* Path MTU. In seconds */
2459 
2460 	ip_stack_t	*dce_ipst;	/* Does not have a netstack_hold */
2461 };
2462 
2463 /*
2464  * Values for dce_generation.
2465  *
2466  * If a DCE has DCE_GENERATION_CONDEMNED, the last dce_refrele should delete
2467  * it.
2468  *
2469  * DCE_GENERATION_VERIFY is never stored in dce_generation but it is
2470  * stored in places that cache DCE (such as ixa_dce_generation).
2471  * It is used as a signal that the cache is stale and needs to be reverified.
2472  */
2473 #define	DCE_GENERATION_CONDEMNED	0
2474 #define	DCE_GENERATION_VERIFY		1
2475 #define	DCE_GENERATION_INITIAL		2
2476 #define	DCE_IS_CONDEMNED(dce) \
2477 	((dce)->dce_generation == DCE_GENERATION_CONDEMNED)
2478 
2479 
2480 /*
2481  * Values for ips_src_generation.
2482  *
2483  * SRC_GENERATION_VERIFY is never stored in ips_src_generation but it is
2484  * stored in places that cache IREs (ixa_src_generation). It is used as a
2485  * signal that the cache is stale and needs to be reverified.
2486  */
2487 #define	SRC_GENERATION_VERIFY		0
2488 #define	SRC_GENERATION_INITIAL		1
2489 
2490 /*
2491  * The kernel stores security attributes of all gateways in a database made
2492  * up of one or more tsol_gcdb_t elements.  Each tsol_gcdb_t contains the
2493  * security-related credentials of the gateway.  More than one gateways may
2494  * share entries in the database.
2495  *
2496  * The tsol_gc_t structure represents the gateway to credential association,
2497  * and refers to an entry in the database.  One or more tsol_gc_t entities are
2498  * grouped together to form one or more tsol_gcgrp_t, each representing the
2499  * list of security attributes specific to the gateway.  A gateway may be
2500  * associated with at most one credentials group.
2501  */
2502 struct tsol_gcgrp_s;
2503 
2504 extern uchar_t	ip6opt_ls;	/* TX IPv6 enabler */
2505 
2506 /*
2507  * Gateway security credential record.
2508  */
2509 typedef struct tsol_gcdb_s {
2510 	uint_t		gcdb_refcnt;	/* reference count */
2511 	struct rtsa_s	gcdb_attr;	/* security attributes */
2512 #define	gcdb_mask	gcdb_attr.rtsa_mask
2513 #define	gcdb_doi	gcdb_attr.rtsa_doi
2514 #define	gcdb_slrange	gcdb_attr.rtsa_slrange
2515 } tsol_gcdb_t;
2516 
2517 /*
2518  * Gateway to credential association.
2519  */
2520 typedef struct tsol_gc_s {
2521 	uint_t		gc_refcnt;	/* reference count */
2522 	struct tsol_gcgrp_s *gc_grp;	/* pointer to group */
2523 	struct tsol_gc_s *gc_prev;	/* previous in list */
2524 	struct tsol_gc_s *gc_next;	/* next in list */
2525 	tsol_gcdb_t	*gc_db;		/* pointer to actual credentials */
2526 } tsol_gc_t;
2527 
2528 /*
2529  * Gateway credentials group address.
2530  */
2531 typedef struct tsol_gcgrp_addr_s {
2532 	int		ga_af;		/* address family */
2533 	in6_addr_t	ga_addr;	/* IPv4 mapped or IPv6 address */
2534 } tsol_gcgrp_addr_t;
2535 
2536 /*
2537  * Gateway credentials group.
2538  */
2539 typedef struct tsol_gcgrp_s {
2540 	uint_t		gcgrp_refcnt;	/* reference count */
2541 	krwlock_t	gcgrp_rwlock;	/* lock to protect following */
2542 	uint_t		gcgrp_count;	/* number of credentials */
2543 	tsol_gc_t	*gcgrp_head;	/* first credential in list */
2544 	tsol_gc_t	*gcgrp_tail;	/* last credential in list */
2545 	tsol_gcgrp_addr_t gcgrp_addr;	/* next-hop gateway address */
2546 } tsol_gcgrp_t;
2547 
2548 extern kmutex_t gcgrp_lock;
2549 
2550 #define	GC_REFRELE(p) {				\
2551 	ASSERT((p)->gc_grp != NULL);		\
2552 	rw_enter(&(p)->gc_grp->gcgrp_rwlock, RW_WRITER); \
2553 	ASSERT((p)->gc_refcnt > 0);		\
2554 	if (--((p)->gc_refcnt) == 0)		\
2555 		gc_inactive(p);			\
2556 	else					\
2557 		rw_exit(&(p)->gc_grp->gcgrp_rwlock); \
2558 }
2559 
2560 #define	GCGRP_REFHOLD(p) {			\
2561 	mutex_enter(&gcgrp_lock);		\
2562 	++((p)->gcgrp_refcnt);			\
2563 	ASSERT((p)->gcgrp_refcnt != 0);		\
2564 	mutex_exit(&gcgrp_lock);		\
2565 }
2566 
2567 #define	GCGRP_REFRELE(p) {			\
2568 	mutex_enter(&gcgrp_lock);		\
2569 	ASSERT((p)->gcgrp_refcnt > 0);		\
2570 	if (--((p)->gcgrp_refcnt) == 0)		\
2571 		gcgrp_inactive(p);		\
2572 	ASSERT(MUTEX_HELD(&gcgrp_lock));	\
2573 	mutex_exit(&gcgrp_lock);		\
2574 }
2575 
2576 /*
2577  * IRE gateway security attributes structure, pointed to by tsol_ire_gw_secattr
2578  */
2579 struct tsol_tnrhc;
2580 
2581 struct tsol_ire_gw_secattr_s {
2582 	kmutex_t	igsa_lock;	/* lock to protect following */
2583 	struct tsol_tnrhc *igsa_rhc;	/* host entry for gateway */
2584 	tsol_gc_t	*igsa_gc;	/* for prefix IREs */
2585 };
2586 
2587 void irb_refrele_ftable(irb_t *);
2588 
2589 extern struct kmem_cache *rt_entry_cache;
2590 
2591 typedef struct ire4 {
2592 	ipaddr_t ire4_mask;		/* Mask for matching this IRE. */
2593 	ipaddr_t ire4_addr;		/* Address this IRE represents. */
2594 	ipaddr_t ire4_gateway_addr;	/* Gateway including for IRE_ONLINK */
2595 	ipaddr_t ire4_setsrc_addr;	/* RTF_SETSRC */
2596 } ire4_t;
2597 
2598 typedef struct ire6 {
2599 	in6_addr_t ire6_mask;		/* Mask for matching this IRE. */
2600 	in6_addr_t ire6_addr;		/* Address this IRE represents. */
2601 	in6_addr_t ire6_gateway_addr;	/* Gateway including for IRE_ONLINK */
2602 	in6_addr_t ire6_setsrc_addr;	/* RTF_SETSRC */
2603 } ire6_t;
2604 
2605 typedef union ire_addr {
2606 	ire6_t	ire6_u;
2607 	ire4_t	ire4_u;
2608 } ire_addr_u_t;
2609 
2610 /*
2611  * Internet Routing Entry
2612  * When we have multiple identical IREs we logically add them by manipulating
2613  * ire_identical_ref and ire_delete first decrements
2614  * that and when it reaches 1 we know it is the last IRE.
2615  * "identical" is defined as being the same for:
2616  * ire_addr, ire_netmask, ire_gateway, ire_ill, ire_zoneid, and ire_type
2617  * For instance, multiple IRE_BROADCASTs for the same subnet number are
2618  * viewed as identical, and so are the IRE_INTERFACEs when there are
2619  * multiple logical interfaces (on the same ill) with the same subnet prefix.
2620  */
2621 struct ire_s {
2622 	struct	ire_s	*ire_next;	/* The hash chain must be first. */
2623 	struct	ire_s	**ire_ptpn;	/* Pointer to previous next. */
2624 	uint32_t	ire_refcnt;	/* Number of references */
2625 	ill_t		*ire_ill;
2626 	uint32_t	ire_identical_ref; /* IRE_INTERFACE, IRE_BROADCAST */
2627 	uchar_t		ire_ipversion;	/* IPv4/IPv6 version */
2628 	ushort_t	ire_type;	/* Type of IRE */
2629 	uint_t		ire_generation;	/* Generation including CONDEMNED */
2630 	uint_t	ire_ib_pkt_count;	/* Inbound packets for ire_addr */
2631 	uint_t	ire_ob_pkt_count;	/* Outbound packets to ire_addr */
2632 	time_t	ire_create_time;	/* Time (in secs) IRE was created. */
2633 	uint32_t	ire_flags;	/* flags related to route (RTF_*) */
2634 	/*
2635 	 * ire_testhidden is TRUE for INTERFACE IREs of IS_UNDER_IPMP(ill)
2636 	 * interfaces
2637 	 */
2638 	boolean_t	ire_testhidden;
2639 	pfirerecv_t	ire_recvfn;	/* Receive side handling */
2640 	pfiresend_t	ire_sendfn;	/* Send side handling */
2641 	pfirepostfrag_t	ire_postfragfn;	/* Bottom end of send handling */
2642 
2643 	uint_t		ire_masklen;	/* # bits in ire_mask{,_v6} */
2644 	ire_addr_u_t	ire_u;		/* IPv4/IPv6 address info. */
2645 
2646 	irb_t		*ire_bucket;	/* Hash bucket when ire_ptphn is set */
2647 	kmutex_t	ire_lock;
2648 	clock_t		ire_last_used_time;	/* For IRE_LOCAL reception */
2649 	tsol_ire_gw_secattr_t *ire_gw_secattr; /* gateway security attributes */
2650 	zoneid_t	ire_zoneid;
2651 
2652 	/*
2653 	 * Cached information of where to send packets that match this route.
2654 	 * The ire_dep_* information is used to determine when ire_nce_cache
2655 	 * needs to be updated.
2656 	 * ire_nce_cache is the fastpath for the Neighbor Cache Entry
2657 	 * for IPv6; arp info for IPv4
2658 	 * Since this is a cache setup and torn down independently of
2659 	 * applications we need to use nce_ref{rele,hold}_notr for it.
2660 	 */
2661 	nce_t		*ire_nce_cache;
2662 
2663 	/*
2664 	 * Quick check whether the ire_type and ire_masklen indicates
2665 	 * that the IRE can have ire_nce_cache set i.e., whether it is
2666 	 * IRE_ONLINK and for a single destination.
2667 	 */
2668 	boolean_t	ire_nce_capable;
2669 
2670 	/*
2671 	 * Dependency tracking so we can safely cache IRE and NCE pointers
2672 	 * in offlink and onlink IREs.
2673 	 * These are locked under the ips_ire_dep_lock rwlock. Write held
2674 	 * when modifying the linkage.
2675 	 * ire_dep_parent (Also chain towards IRE for nexthop)
2676 	 * ire_dep_parent_generation: ire_generation of ire_dep_parent
2677 	 * ire_dep_children (From parent to first child)
2678 	 * ire_dep_sib_next (linked list of siblings)
2679 	 * ire_dep_sib_ptpn (linked list of siblings)
2680 	 *
2681 	 * The parent has a ire_refhold on each child, and each child has
2682 	 * an ire_refhold on its parent.
2683 	 * Since ire_dep_parent is a cache setup and torn down independently of
2684 	 * applications we need to use ire_ref{rele,hold}_notr for it.
2685 	 */
2686 	ire_t		*ire_dep_parent;
2687 	ire_t		*ire_dep_children;
2688 	ire_t		*ire_dep_sib_next;
2689 	ire_t		**ire_dep_sib_ptpn;	/* Pointer to previous next */
2690 	uint_t		ire_dep_parent_generation;
2691 
2692 	uint_t		ire_badcnt;	/* Number of times ND_UNREACHABLE */
2693 	uint64_t	ire_last_badcnt;	/* In seconds */
2694 
2695 	/* ire_defense* and ire_last_used_time are only used on IRE_LOCALs */
2696 	uint_t		ire_defense_count;	/* number of ARP conflicts */
2697 	uint_t		ire_defense_time;	/* last time defended (secs) */
2698 
2699 	boolean_t	ire_trace_disable;	/* True when alloc fails */
2700 	ip_stack_t	*ire_ipst;	/* Does not have a netstack_hold */
2701 	iulp_t		ire_metrics;
2702 	/*
2703 	 * default and prefix routes that are added without explicitly
2704 	 * specifying the interface are termed "unbound" routes, and will
2705 	 * have ire_unbound set to true.
2706 	 */
2707 	boolean_t	ire_unbound;
2708 };
2709 
2710 /* IPv4 compatibility macros */
2711 #define	ire_mask		ire_u.ire4_u.ire4_mask
2712 #define	ire_addr		ire_u.ire4_u.ire4_addr
2713 #define	ire_gateway_addr	ire_u.ire4_u.ire4_gateway_addr
2714 #define	ire_setsrc_addr		ire_u.ire4_u.ire4_setsrc_addr
2715 
2716 #define	ire_mask_v6		ire_u.ire6_u.ire6_mask
2717 #define	ire_addr_v6		ire_u.ire6_u.ire6_addr
2718 #define	ire_gateway_addr_v6	ire_u.ire6_u.ire6_gateway_addr
2719 #define	ire_setsrc_addr_v6	ire_u.ire6_u.ire6_setsrc_addr
2720 
2721 /*
2722  * Values for ire_generation.
2723  *
2724  * If an IRE is marked with IRE_IS_CONDEMNED, the last walker of
2725  * the bucket should delete this IRE from this bucket.
2726  *
2727  * IRE_GENERATION_VERIFY is never stored in ire_generation but it is
2728  * stored in places that cache IREs (such as ixa_ire_generation and
2729  * ire_dep_parent_generation). It is used as a signal that the cache is
2730  * stale and needs to be reverified.
2731  */
2732 #define	IRE_GENERATION_CONDEMNED	0
2733 #define	IRE_GENERATION_VERIFY		1
2734 #define	IRE_GENERATION_INITIAL		2
2735 #define	IRE_IS_CONDEMNED(ire) \
2736 	((ire)->ire_generation == IRE_GENERATION_CONDEMNED)
2737 
2738 /* Convenient typedefs for sockaddrs */
2739 typedef	struct sockaddr_in	sin_t;
2740 typedef	struct sockaddr_in6	sin6_t;
2741 
2742 /* Name/Value Descriptor. */
2743 typedef struct nv_s {
2744 	uint64_t nv_value;
2745 	char	*nv_name;
2746 } nv_t;
2747 
2748 #define	ILL_FRAG_HASH(s, i) \
2749 	((ntohl(s) ^ ((i) ^ ((i) >> 8))) % ILL_FRAG_HASH_TBL_COUNT)
2750 
2751 /*
2752  * The MAX number of allowed fragmented packets per hash bucket
2753  * calculation is based on the most common mtu size of 1500. This limit
2754  * will work well for other mtu sizes as well.
2755  */
2756 #define	COMMON_IP_MTU 1500
2757 #define	MAX_FRAG_MIN 10
2758 #define	MAX_FRAG_PKTS(ipst)	\
2759 	MAX(MAX_FRAG_MIN, (2 * (ipst->ips_ip_reass_queue_bytes / \
2760 	    (COMMON_IP_MTU * ILL_FRAG_HASH_TBL_COUNT))))
2761 
2762 /*
2763  * Maximum dups allowed per packet.
2764  */
2765 extern uint_t ip_max_frag_dups;
2766 
2767 /*
2768  * Per-packet information for received packets and transmitted.
2769  * Used by the transport protocols when converting between the packet
2770  * and ancillary data and socket options.
2771  *
2772  * Note: This private data structure and related IPPF_* constant
2773  * definitions are exposed to enable compilation of some debugging tools
2774  * like lsof which use struct tcp_t in <inet/tcp.h>. This is intended to be
2775  * a temporary hack and long term alternate interfaces should be defined
2776  * to support the needs of such tools and private definitions moved to
2777  * private headers.
2778  */
2779 struct ip_pkt_s {
2780 	uint_t		ipp_fields;		/* Which fields are valid */
2781 	in6_addr_t	ipp_addr;		/* pktinfo src/dst addr */
2782 #define	ipp_addr_v4	V4_PART_OF_V6(ipp_addr)
2783 	uint_t		ipp_unicast_hops;	/* IPV6_UNICAST_HOPS, IP_TTL */
2784 	uint_t		ipp_hoplimit;		/* IPV6_HOPLIMIT */
2785 	uint_t		ipp_hopoptslen;
2786 	uint_t		ipp_rthdrdstoptslen;
2787 	uint_t		ipp_rthdrlen;
2788 	uint_t		ipp_dstoptslen;
2789 	uint_t		ipp_fraghdrlen;
2790 	ip6_hbh_t	*ipp_hopopts;
2791 	ip6_dest_t	*ipp_rthdrdstopts;
2792 	ip6_rthdr_t	*ipp_rthdr;
2793 	ip6_dest_t	*ipp_dstopts;
2794 	ip6_frag_t	*ipp_fraghdr;
2795 	uint8_t		ipp_tclass;		/* IPV6_TCLASS */
2796 	uint8_t		ipp_type_of_service;	/* IP_TOS */
2797 	uint_t		ipp_ipv4_options_len;	/* Len of IPv4 options */
2798 	uint8_t		*ipp_ipv4_options;	/* Ptr to IPv4 options */
2799 	uint_t		ipp_label_len_v4;	/* Len of TX label for IPv4 */
2800 	uint8_t		*ipp_label_v4;		/* TX label for IPv4 */
2801 	uint_t		ipp_label_len_v6;	/* Len of TX label for IPv6 */
2802 	uint8_t		*ipp_label_v6;		/* TX label for IPv6 */
2803 };
2804 typedef struct ip_pkt_s ip_pkt_t;
2805 
2806 extern void ip_pkt_free(ip_pkt_t *);	/* free storage inside ip_pkt_t */
2807 extern ipaddr_t ip_pkt_source_route_v4(const ip_pkt_t *);
2808 extern in6_addr_t *ip_pkt_source_route_v6(const ip_pkt_t *);
2809 extern int ip_pkt_copy(ip_pkt_t *, ip_pkt_t *, int);
2810 extern void ip_pkt_source_route_reverse_v4(ip_pkt_t *);
2811 
2812 /* ipp_fields values */
2813 #define	IPPF_ADDR		0x0001	/* Part of in6_pktinfo: src/dst addr */
2814 #define	IPPF_HOPLIMIT		0x0002	/* Overrides unicast and multicast */
2815 #define	IPPF_TCLASS		0x0004	/* Overrides class in sin6_flowinfo */
2816 
2817 #define	IPPF_HOPOPTS		0x0010	/* ipp_hopopts set */
2818 #define	IPPF_RTHDR		0x0020	/* ipp_rthdr set */
2819 #define	IPPF_RTHDRDSTOPTS	0x0040	/* ipp_rthdrdstopts set */
2820 #define	IPPF_DSTOPTS		0x0080	/* ipp_dstopts set */
2821 
2822 #define	IPPF_IPV4_OPTIONS	0x0100	/* ipp_ipv4_options set */
2823 #define	IPPF_LABEL_V4		0x0200	/* ipp_label_v4 set */
2824 #define	IPPF_LABEL_V6		0x0400	/* ipp_label_v6 set */
2825 
2826 #define	IPPF_FRAGHDR		0x0800	/* Used for IPsec receive side */
2827 
2828 /*
2829  * Data structure which is passed to conn_opt_get/set.
2830  * The conn_t is included even though it can be inferred from queue_t.
2831  * setsockopt and getsockopt use conn_ixa and conn_xmit_ipp. However,
2832  * when handling ancillary data we use separate ixa and ipps.
2833  */
2834 typedef struct conn_opt_arg_s {
2835 	conn_t		*coa_connp;
2836 	ip_xmit_attr_t	*coa_ixa;
2837 	ip_pkt_t	*coa_ipp;
2838 	boolean_t	coa_ancillary;	/* Ancillary data and not setsockopt */
2839 	uint_t		coa_changed;	/* See below */
2840 } conn_opt_arg_t;
2841 
2842 /*
2843  * Flags for what changed.
2844  * If we want to be more efficient in the future we can have more fine
2845  * grained flags e.g., a flag for just IP_TOS changing.
2846  * For now we either call ip_set_destination (for "route changed")
2847  * and/or conn_build_hdr_template/conn_prepend_hdr (for "header changed").
2848  */
2849 #define	COA_HEADER_CHANGED	0x0001
2850 #define	COA_ROUTE_CHANGED	0x0002
2851 #define	COA_RCVBUF_CHANGED	0x0004	/* SO_RCVBUF */
2852 #define	COA_SNDBUF_CHANGED	0x0008	/* SO_SNDBUF */
2853 #define	COA_WROFF_CHANGED	0x0010	/* Header size changed */
2854 #define	COA_ICMP_BIND_NEEDED	0x0020
2855 #define	COA_OOBINLINE_CHANGED	0x0040
2856 
2857 #define	TCP_PORTS_OFFSET	0
2858 #define	UDP_PORTS_OFFSET	0
2859 
2860 /*
2861  * lookups return the ill/ipif only if the flags are clear OR Iam writer.
2862  * ill / ipif lookup functions increment the refcnt on the ill / ipif only
2863  * after calling these macros. This ensures that the refcnt on the ipif or
2864  * ill will eventually drop down to zero.
2865  */
2866 #define	ILL_LOOKUP_FAILED	1	/* Used as error code */
2867 #define	IPIF_LOOKUP_FAILED	2	/* Used as error code */
2868 
2869 #define	ILL_CAN_LOOKUP(ill)						\
2870 	(!((ill)->ill_state_flags & ILL_CONDEMNED) ||			\
2871 	IAM_WRITER_ILL(ill))
2872 
2873 #define	ILL_IS_CONDEMNED(ill)	\
2874 	((ill)->ill_state_flags & ILL_CONDEMNED)
2875 
2876 #define	IPIF_CAN_LOOKUP(ipif)	\
2877 	(!((ipif)->ipif_state_flags & IPIF_CONDEMNED) || \
2878 	IAM_WRITER_IPIF(ipif))
2879 
2880 #define	IPIF_IS_CONDEMNED(ipif)	\
2881 	((ipif)->ipif_state_flags & IPIF_CONDEMNED)
2882 
2883 #define	IPIF_IS_CHANGING(ipif)	\
2884 	((ipif)->ipif_state_flags & IPIF_CHANGING)
2885 
2886 /* Macros used to assert that this thread is a writer */
2887 #define	IAM_WRITER_IPSQ(ipsq)	((ipsq)->ipsq_xop->ipx_writer == curthread)
2888 #define	IAM_WRITER_ILL(ill)	IAM_WRITER_IPSQ((ill)->ill_phyint->phyint_ipsq)
2889 #define	IAM_WRITER_IPIF(ipif)	IAM_WRITER_ILL((ipif)->ipif_ill)
2890 
2891 /*
2892  * Grab ill locks in the proper order. The order is highest addressed
2893  * ill is locked first.
2894  */
2895 #define	GRAB_ILL_LOCKS(ill_1, ill_2)				\
2896 {								\
2897 	if ((ill_1) > (ill_2)) {				\
2898 		if (ill_1 != NULL)				\
2899 			mutex_enter(&(ill_1)->ill_lock);	\
2900 		if (ill_2 != NULL)				\
2901 			mutex_enter(&(ill_2)->ill_lock);	\
2902 	} else {						\
2903 		if (ill_2 != NULL)				\
2904 			mutex_enter(&(ill_2)->ill_lock);	\
2905 		if (ill_1 != NULL && ill_1 != ill_2)		\
2906 			mutex_enter(&(ill_1)->ill_lock);	\
2907 	}							\
2908 }
2909 
2910 #define	RELEASE_ILL_LOCKS(ill_1, ill_2)		\
2911 {						\
2912 	if (ill_1 != NULL)			\
2913 		mutex_exit(&(ill_1)->ill_lock);	\
2914 	if (ill_2 != NULL && ill_2 != ill_1)	\
2915 		mutex_exit(&(ill_2)->ill_lock);	\
2916 }
2917 
2918 /* Get the other protocol instance ill */
2919 #define	ILL_OTHER(ill)						\
2920 	((ill)->ill_isv6 ? (ill)->ill_phyint->phyint_illv4 :	\
2921 	    (ill)->ill_phyint->phyint_illv6)
2922 
2923 /* ioctl command info: Ioctl properties extracted and stored in here */
2924 typedef struct cmd_info_s
2925 {
2926 	ipif_t  *ci_ipif;	/* ipif associated with [l]ifreq ioctl's */
2927 	sin_t	*ci_sin;	/* the sin struct passed down */
2928 	sin6_t	*ci_sin6;	/* the sin6_t struct passed down */
2929 	struct lifreq *ci_lifr;	/* the lifreq struct passed down */
2930 } cmd_info_t;
2931 
2932 extern struct kmem_cache *ire_cache;
2933 
2934 extern ipaddr_t	ip_g_all_ones;
2935 
2936 extern uint_t	ip_loopback_mtu;	/* /etc/system */
2937 extern uint_t	ip_loopback_mtuplus;
2938 extern uint_t	ip_loopback_mtu_v6plus;
2939 
2940 extern vmem_t *ip_minor_arena_sa;
2941 extern vmem_t *ip_minor_arena_la;
2942 
2943 /*
2944  * ip_g_forward controls IP forwarding.  It takes two values:
2945  *	0: IP_FORWARD_NEVER	Don't forward packets ever.
2946  *	1: IP_FORWARD_ALWAYS	Forward packets for elsewhere.
2947  *
2948  * RFC1122 says there must be a configuration switch to control forwarding,
2949  * but that the default MUST be to not forward packets ever.  Implicit
2950  * control based on configuration of multiple interfaces MUST NOT be
2951  * implemented (Section 3.1).  SunOS 4.1 did provide the "automatic" capability
2952  * and, in fact, it was the default.  That capability is now provided in the
2953  * /etc/rc2.d/S69inet script.
2954  */
2955 
2956 #define	ips_ip_respond_to_address_mask_broadcast \
2957 					ips_propinfo_tbl[0].prop_cur_bval
2958 #define	ips_ip_g_resp_to_echo_bcast	ips_propinfo_tbl[1].prop_cur_bval
2959 #define	ips_ip_g_resp_to_echo_mcast	ips_propinfo_tbl[2].prop_cur_bval
2960 #define	ips_ip_g_resp_to_timestamp	ips_propinfo_tbl[3].prop_cur_bval
2961 #define	ips_ip_g_resp_to_timestamp_bcast ips_propinfo_tbl[4].prop_cur_bval
2962 #define	ips_ip_g_send_redirects		ips_propinfo_tbl[5].prop_cur_bval
2963 #define	ips_ip_g_forward_directed_bcast	ips_propinfo_tbl[6].prop_cur_bval
2964 #define	ips_ip_mrtdebug			ips_propinfo_tbl[7].prop_cur_uval
2965 #define	ips_ip_ire_reclaim_fraction	ips_propinfo_tbl[8].prop_cur_uval
2966 #define	ips_ip_nce_reclaim_fraction	ips_propinfo_tbl[9].prop_cur_uval
2967 #define	ips_ip_dce_reclaim_fraction	ips_propinfo_tbl[10].prop_cur_uval
2968 #define	ips_ip_def_ttl			ips_propinfo_tbl[11].prop_cur_uval
2969 #define	ips_ip_forward_src_routed	ips_propinfo_tbl[12].prop_cur_bval
2970 #define	ips_ip_wroff_extra		ips_propinfo_tbl[13].prop_cur_uval
2971 #define	ips_ip_pathmtu_interval		ips_propinfo_tbl[14].prop_cur_uval
2972 #define	ips_ip_icmp_return		ips_propinfo_tbl[15].prop_cur_uval
2973 #define	ips_ip_path_mtu_discovery	ips_propinfo_tbl[16].prop_cur_bval
2974 #define	ips_ip_pmtu_min			ips_propinfo_tbl[17].prop_cur_uval
2975 #define	ips_ip_ignore_redirect		ips_propinfo_tbl[18].prop_cur_bval
2976 #define	ips_ip_arp_icmp_error		ips_propinfo_tbl[19].prop_cur_bval
2977 #define	ips_ip_broadcast_ttl		ips_propinfo_tbl[20].prop_cur_uval
2978 #define	ips_ip_icmp_err_interval	ips_propinfo_tbl[21].prop_cur_uval
2979 #define	ips_ip_icmp_err_burst		ips_propinfo_tbl[22].prop_cur_uval
2980 #define	ips_ip_reass_queue_bytes	ips_propinfo_tbl[23].prop_cur_uval
2981 #define	ips_ip_strict_dst_multihoming	ips_propinfo_tbl[24].prop_cur_uval
2982 #define	ips_ip_addrs_per_if		ips_propinfo_tbl[25].prop_cur_uval
2983 #define	ips_ipsec_override_persocket_policy ips_propinfo_tbl[26].prop_cur_bval
2984 #define	ips_icmp_accept_clear_messages	ips_propinfo_tbl[27].prop_cur_bval
2985 #define	ips_igmp_accept_clear_messages	ips_propinfo_tbl[28].prop_cur_bval
2986 
2987 /* IPv6 configuration knobs */
2988 #define	ips_delay_first_probe_time	ips_propinfo_tbl[29].prop_cur_uval
2989 #define	ips_max_unicast_solicit		ips_propinfo_tbl[30].prop_cur_uval
2990 #define	ips_ipv6_def_hops		ips_propinfo_tbl[31].prop_cur_uval
2991 #define	ips_ipv6_icmp_return		ips_propinfo_tbl[32].prop_cur_uval
2992 #define	ips_ipv6_forward_src_routed	ips_propinfo_tbl[33].prop_cur_bval
2993 #define	ips_ipv6_resp_echo_mcast	ips_propinfo_tbl[34].prop_cur_bval
2994 #define	ips_ipv6_send_redirects		ips_propinfo_tbl[35].prop_cur_bval
2995 #define	ips_ipv6_ignore_redirect	ips_propinfo_tbl[36].prop_cur_bval
2996 #define	ips_ipv6_strict_dst_multihoming	ips_propinfo_tbl[37].prop_cur_uval
2997 #define	ips_src_check			ips_propinfo_tbl[38].prop_cur_uval
2998 #define	ips_ipsec_policy_log_interval	ips_propinfo_tbl[39].prop_cur_uval
2999 #define	ips_pim_accept_clear_messages	ips_propinfo_tbl[40].prop_cur_bval
3000 #define	ips_ip_ndp_unsolicit_interval	ips_propinfo_tbl[41].prop_cur_uval
3001 #define	ips_ip_ndp_unsolicit_count	ips_propinfo_tbl[42].prop_cur_uval
3002 #define	ips_ipv6_ignore_home_address_opt ips_propinfo_tbl[43].prop_cur_bval
3003 
3004 /* Misc IP configuration knobs */
3005 #define	ips_ip_policy_mask		ips_propinfo_tbl[44].prop_cur_uval
3006 #define	ips_ip_ecmp_behavior		ips_propinfo_tbl[45].prop_cur_uval
3007 #define	ips_ip_multirt_ttl  		ips_propinfo_tbl[46].prop_cur_uval
3008 #define	ips_ip_ire_badcnt_lifetime	ips_propinfo_tbl[47].prop_cur_uval
3009 #define	ips_ip_max_temp_idle		ips_propinfo_tbl[48].prop_cur_uval
3010 #define	ips_ip_max_temp_defend		ips_propinfo_tbl[49].prop_cur_uval
3011 #define	ips_ip_max_defend		ips_propinfo_tbl[50].prop_cur_uval
3012 #define	ips_ip_defend_interval		ips_propinfo_tbl[51].prop_cur_uval
3013 #define	ips_ip_dup_recovery		ips_propinfo_tbl[52].prop_cur_uval
3014 #define	ips_ip_restrict_interzone_loopback ips_propinfo_tbl[53].prop_cur_bval
3015 #define	ips_ip_lso_outbound		ips_propinfo_tbl[54].prop_cur_bval
3016 #define	ips_igmp_max_version		ips_propinfo_tbl[55].prop_cur_uval
3017 #define	ips_mld_max_version		ips_propinfo_tbl[56].prop_cur_uval
3018 #define	ips_ip_forwarding		ips_propinfo_tbl[57].prop_cur_bval
3019 #define	ips_ipv6_forwarding		ips_propinfo_tbl[58].prop_cur_bval
3020 #define	ips_ip_reassembly_timeout	ips_propinfo_tbl[59].prop_cur_uval
3021 #define	ips_ipv6_reassembly_timeout	ips_propinfo_tbl[60].prop_cur_uval
3022 #define	ips_ip_cgtp_filter		ips_propinfo_tbl[61].prop_cur_bval
3023 #define	ips_arp_probe_delay		ips_propinfo_tbl[62].prop_cur_uval
3024 #define	ips_arp_fastprobe_delay		ips_propinfo_tbl[63].prop_cur_uval
3025 #define	ips_arp_probe_interval		ips_propinfo_tbl[64].prop_cur_uval
3026 #define	ips_arp_fastprobe_interval	ips_propinfo_tbl[65].prop_cur_uval
3027 #define	ips_arp_probe_count		ips_propinfo_tbl[66].prop_cur_uval
3028 #define	ips_arp_fastprobe_count		ips_propinfo_tbl[67].prop_cur_uval
3029 #define	ips_ipv4_dad_announce_interval	ips_propinfo_tbl[68].prop_cur_uval
3030 #define	ips_ipv6_dad_announce_interval	ips_propinfo_tbl[69].prop_cur_uval
3031 #define	ips_arp_defend_interval		ips_propinfo_tbl[70].prop_cur_uval
3032 #define	ips_arp_defend_rate		ips_propinfo_tbl[71].prop_cur_uval
3033 #define	ips_ndp_defend_interval		ips_propinfo_tbl[72].prop_cur_uval
3034 #define	ips_ndp_defend_rate		ips_propinfo_tbl[73].prop_cur_uval
3035 #define	ips_arp_defend_period		ips_propinfo_tbl[74].prop_cur_uval
3036 #define	ips_ndp_defend_period		ips_propinfo_tbl[75].prop_cur_uval
3037 #define	ips_ipv4_icmp_return_pmtu	ips_propinfo_tbl[76].prop_cur_bval
3038 #define	ips_ipv6_icmp_return_pmtu	ips_propinfo_tbl[77].prop_cur_bval
3039 #define	ips_ip_arp_publish_count	ips_propinfo_tbl[78].prop_cur_uval
3040 #define	ips_ip_arp_publish_interval	ips_propinfo_tbl[79].prop_cur_uval
3041 #define	ips_ip_strict_src_multihoming	ips_propinfo_tbl[80].prop_cur_uval
3042 #define	ips_ipv6_strict_src_multihoming	ips_propinfo_tbl[81].prop_cur_uval
3043 #define	ips_ipv6_drop_inbound_icmpv6	ips_propinfo_tbl[82].prop_cur_bval
3044 #define	ips_ip_dce_reclaim_threshold	ips_propinfo_tbl[83].prop_cur_uval
3045 
3046 extern int	dohwcksum;	/* use h/w cksum if supported by the h/w */
3047 #ifdef ZC_TEST
3048 extern int	noswcksum;
3049 #endif
3050 
3051 extern char	ipif_loopback_name[];
3052 
3053 extern nv_t	*ire_nv_tbl;
3054 
3055 extern struct module_info ip_mod_info;
3056 
3057 #define	HOOKS4_INTERESTED_PHYSICAL_IN(ipst)	\
3058 	((ipst)->ips_ip4_physical_in_event.he_interested)
3059 #define	HOOKS6_INTERESTED_PHYSICAL_IN(ipst)	\
3060 	((ipst)->ips_ip6_physical_in_event.he_interested)
3061 #define	HOOKS4_INTERESTED_PHYSICAL_OUT(ipst)	\
3062 	((ipst)->ips_ip4_physical_out_event.he_interested)
3063 #define	HOOKS6_INTERESTED_PHYSICAL_OUT(ipst)	\
3064 	((ipst)->ips_ip6_physical_out_event.he_interested)
3065 #define	HOOKS4_INTERESTED_FORWARDING(ipst)	\
3066 	((ipst)->ips_ip4_forwarding_event.he_interested)
3067 #define	HOOKS6_INTERESTED_FORWARDING(ipst)	\
3068 	((ipst)->ips_ip6_forwarding_event.he_interested)
3069 #define	HOOKS4_INTERESTED_LOOPBACK_IN(ipst)	\
3070 	((ipst)->ips_ip4_loopback_in_event.he_interested)
3071 #define	HOOKS6_INTERESTED_LOOPBACK_IN(ipst)	\
3072 	((ipst)->ips_ip6_loopback_in_event.he_interested)
3073 #define	HOOKS4_INTERESTED_LOOPBACK_OUT(ipst)	\
3074 	((ipst)->ips_ip4_loopback_out_event.he_interested)
3075 #define	HOOKS6_INTERESTED_LOOPBACK_OUT(ipst)	\
3076 	((ipst)->ips_ip6_loopback_out_event.he_interested)
3077 /*
3078  * Hooks marcos used inside of ip
3079  * The callers use the above INTERESTED macros first, hence
3080  * the he_interested check is superflous.
3081  */
3082 #define	FW_HOOKS(_hook, _event, _ilp, _olp, _iph, _fm, _m, _llm, ipst, _err) \
3083 	if ((_hook).he_interested) {					\
3084 		hook_pkt_event_t info;					\
3085 									\
3086 		_NOTE(CONSTCOND)					\
3087 		ASSERT((_ilp != NULL) || (_olp != NULL));		\
3088 									\
3089 		FW_SET_ILL_INDEX(info.hpe_ifp, (ill_t *)_ilp);		\
3090 		FW_SET_ILL_INDEX(info.hpe_ofp, (ill_t *)_olp);		\
3091 		info.hpe_protocol = ipst->ips_ipv4_net_data;		\
3092 		info.hpe_hdr = _iph;					\
3093 		info.hpe_mp = &(_fm);					\
3094 		info.hpe_mb = _m;					\
3095 		info.hpe_flags = _llm;					\
3096 		_err = hook_run(ipst->ips_ipv4_net_data->netd_hooks,	\
3097 		    _event, (hook_data_t)&info);			\
3098 		if (_err != 0) {					\
3099 			ip2dbg(("%s hook dropped mblk chain %p hdr %p\n",\
3100 			    (_hook).he_name, (void *)_fm, (void *)_m));	\
3101 			if (_fm != NULL) {				\
3102 				freemsg(_fm);				\
3103 				_fm = NULL;				\
3104 			}						\
3105 			_iph = NULL;					\
3106 			_m = NULL;					\
3107 		} else {						\
3108 			_iph = info.hpe_hdr;				\
3109 			_m = info.hpe_mb;				\
3110 		}							\
3111 	}
3112 
3113 #define	FW_HOOKS6(_hook, _event, _ilp, _olp, _iph, _fm, _m, _llm, ipst, _err) \
3114 	if ((_hook).he_interested) {					\
3115 		hook_pkt_event_t info;					\
3116 									\
3117 		_NOTE(CONSTCOND)					\
3118 		ASSERT((_ilp != NULL) || (_olp != NULL));		\
3119 									\
3120 		FW_SET_ILL_INDEX(info.hpe_ifp, (ill_t *)_ilp);		\
3121 		FW_SET_ILL_INDEX(info.hpe_ofp, (ill_t *)_olp);		\
3122 		info.hpe_protocol = ipst->ips_ipv6_net_data;		\
3123 		info.hpe_hdr = _iph;					\
3124 		info.hpe_mp = &(_fm);					\
3125 		info.hpe_mb = _m;					\
3126 		info.hpe_flags = _llm;					\
3127 		_err = hook_run(ipst->ips_ipv6_net_data->netd_hooks,	\
3128 		    _event, (hook_data_t)&info);			\
3129 		if (_err != 0) {					\
3130 			ip2dbg(("%s hook dropped mblk chain %p hdr %p\n",\
3131 			    (_hook).he_name, (void *)_fm, (void *)_m));	\
3132 			if (_fm != NULL) {				\
3133 				freemsg(_fm);				\
3134 				_fm = NULL;				\
3135 			}						\
3136 			_iph = NULL;					\
3137 			_m = NULL;					\
3138 		} else {						\
3139 			_iph = info.hpe_hdr;				\
3140 			_m = info.hpe_mb;				\
3141 		}							\
3142 	}
3143 
3144 #define	FW_SET_ILL_INDEX(fp, ill)					\
3145 	_NOTE(CONSTCOND)						\
3146 	if ((ill) == NULL || (ill)->ill_phyint == NULL) {		\
3147 		(fp) = 0;						\
3148 		_NOTE(CONSTCOND)					\
3149 	} else if (IS_UNDER_IPMP(ill)) {				\
3150 		(fp) = ipmp_ill_get_ipmp_ifindex(ill);			\
3151 	} else {							\
3152 		(fp) = (ill)->ill_phyint->phyint_ifindex;		\
3153 	}
3154 
3155 /*
3156  * Network byte order macros
3157  */
3158 #ifdef	_BIG_ENDIAN
3159 #define	N_IN_CLASSA_NET		IN_CLASSA_NET
3160 #define	N_IN_CLASSD_NET		IN_CLASSD_NET
3161 #define	N_INADDR_UNSPEC_GROUP	INADDR_UNSPEC_GROUP
3162 #define	N_IN_LOOPBACK_NET	(ipaddr_t)0x7f000000U
3163 #else /* _BIG_ENDIAN */
3164 #define	N_IN_CLASSA_NET		(ipaddr_t)0x000000ffU
3165 #define	N_IN_CLASSD_NET		(ipaddr_t)0x000000f0U
3166 #define	N_INADDR_UNSPEC_GROUP	(ipaddr_t)0x000000e0U
3167 #define	N_IN_LOOPBACK_NET	(ipaddr_t)0x0000007fU
3168 #endif /* _BIG_ENDIAN */
3169 #define	CLASSD(addr)	(((addr) & N_IN_CLASSD_NET) == N_INADDR_UNSPEC_GROUP)
3170 #define	CLASSE(addr)	(((addr) & N_IN_CLASSD_NET) == N_IN_CLASSD_NET)
3171 #define	IP_LOOPBACK_ADDR(addr)			\
3172 	(((addr) & N_IN_CLASSA_NET == N_IN_LOOPBACK_NET))
3173 
3174 extern int	ip_debug;
3175 extern uint_t	ip_thread_data;
3176 extern krwlock_t ip_thread_rwlock;
3177 extern list_t	ip_thread_list;
3178 
3179 #ifdef IP_DEBUG
3180 #include <sys/debug.h>
3181 #include <sys/promif.h>
3182 
3183 #define	ip0dbg(a)	printf a
3184 #define	ip1dbg(a)	if (ip_debug > 2) printf a
3185 #define	ip2dbg(a)	if (ip_debug > 3) printf a
3186 #define	ip3dbg(a)	if (ip_debug > 4) printf a
3187 #else
3188 #define	ip0dbg(a)	/* */
3189 #define	ip1dbg(a)	/* */
3190 #define	ip2dbg(a)	/* */
3191 #define	ip3dbg(a)	/* */
3192 #endif	/* IP_DEBUG */
3193 
3194 /* Default MAC-layer address string length for mac_colon_addr */
3195 #define	MAC_STR_LEN	128
3196 
3197 struct	mac_header_info_s;
3198 
3199 extern void	ill_frag_timer(void *);
3200 extern ill_t	*ill_first(int, int, ill_walk_context_t *, ip_stack_t *);
3201 extern ill_t	*ill_next(ill_walk_context_t *, ill_t *);
3202 extern void	ill_frag_timer_start(ill_t *);
3203 extern void	ill_nic_event_dispatch(ill_t *, lif_if_t, nic_event_t,
3204     nic_event_data_t, size_t);
3205 extern mblk_t	*ip_carve_mp(mblk_t **, ssize_t);
3206 extern mblk_t	*ip_dlpi_alloc(size_t, t_uscalar_t);
3207 extern mblk_t	*ip_dlnotify_alloc(uint_t, uint_t);
3208 extern mblk_t	*ip_dlnotify_alloc2(uint_t, uint_t, uint_t);
3209 extern char	*ip_dot_addr(ipaddr_t, char *);
3210 extern const char *mac_colon_addr(const uint8_t *, size_t, char *, size_t);
3211 extern void	ip_lwput(queue_t *, mblk_t *);
3212 extern boolean_t icmp_err_rate_limit(ip_stack_t *);
3213 extern void	icmp_frag_needed(mblk_t *, int, ip_recv_attr_t *);
3214 extern mblk_t	*icmp_inbound_v4(mblk_t *, ip_recv_attr_t *);
3215 extern void	icmp_time_exceeded(mblk_t *, uint8_t, ip_recv_attr_t *);
3216 extern void	icmp_unreachable(mblk_t *, uint8_t, ip_recv_attr_t *);
3217 extern boolean_t ip_ipsec_policy_inherit(conn_t *, conn_t *, ip_recv_attr_t *);
3218 extern void	*ip_pullup(mblk_t *, ssize_t, ip_recv_attr_t *);
3219 extern void	ip_setl2src(mblk_t *, ip_recv_attr_t *, ill_t *);
3220 extern mblk_t	*ip_check_and_align_header(mblk_t *, uint_t, ip_recv_attr_t *);
3221 extern mblk_t	*ip_check_length(mblk_t *, uchar_t *, ssize_t, uint_t, uint_t,
3222     ip_recv_attr_t *);
3223 extern mblk_t	*ip_check_optlen(mblk_t *, ipha_t *, uint_t, uint_t,
3224     ip_recv_attr_t *);
3225 extern mblk_t	*ip_fix_dbref(mblk_t *, ip_recv_attr_t *);
3226 extern uint_t	ip_cksum(mblk_t *, int, uint32_t);
3227 extern int	ip_close(queue_t *, int);
3228 extern uint16_t	ip_csum_hdr(ipha_t *);
3229 extern void	ip_forward_xmit_v4(nce_t *, ill_t *, mblk_t *, ipha_t *,
3230     ip_recv_attr_t *, uint32_t, uint32_t);
3231 extern boolean_t ip_forward_options(mblk_t *, ipha_t *, ill_t *,
3232     ip_recv_attr_t *);
3233 extern int	ip_fragment_v4(mblk_t *, nce_t *, iaflags_t, uint_t, uint32_t,
3234     uint32_t, zoneid_t, zoneid_t, pfirepostfrag_t postfragfn,
3235     uintptr_t *cookie);
3236 extern void	ip_proto_not_sup(mblk_t *, ip_recv_attr_t *);
3237 extern void	ip_ire_g_fini(void);
3238 extern void	ip_ire_g_init(void);
3239 extern void	ip_ire_fini(ip_stack_t *);
3240 extern void	ip_ire_init(ip_stack_t *);
3241 extern void	ip_mdata_to_mhi(ill_t *, mblk_t *, struct mac_header_info_s *);
3242 extern int	ip_openv4(queue_t *q, dev_t *devp, int flag, int sflag,
3243 		    cred_t *credp);
3244 extern int	ip_openv6(queue_t *q, dev_t *devp, int flag, int sflag,
3245 		    cred_t *credp);
3246 extern int	ip_reassemble(mblk_t *, ipf_t *, uint_t, boolean_t, ill_t *,
3247     size_t);
3248 extern void	ip_rput(queue_t *, mblk_t *);
3249 extern void	ip_input(ill_t *, ill_rx_ring_t *, mblk_t *,
3250     struct mac_header_info_s *);
3251 extern void	ip_input_v6(ill_t *, ill_rx_ring_t *, mblk_t *,
3252     struct mac_header_info_s *);
3253 extern mblk_t	*ip_input_common_v4(ill_t *, ill_rx_ring_t *, mblk_t *,
3254     struct mac_header_info_s *, squeue_t *, mblk_t **, uint_t *);
3255 extern mblk_t	*ip_input_common_v6(ill_t *, ill_rx_ring_t *, mblk_t *,
3256     struct mac_header_info_s *, squeue_t *, mblk_t **, uint_t *);
3257 extern void	ill_input_full_v4(mblk_t *, void *, void *,
3258     ip_recv_attr_t *, rtc_t *);
3259 extern void	ill_input_short_v4(mblk_t *, void *, void *,
3260     ip_recv_attr_t *, rtc_t *);
3261 extern void	ill_input_full_v6(mblk_t *, void *, void *,
3262     ip_recv_attr_t *, rtc_t *);
3263 extern void	ill_input_short_v6(mblk_t *, void *, void *,
3264     ip_recv_attr_t *, rtc_t *);
3265 extern ipaddr_t	ip_input_options(ipha_t *, ipaddr_t, mblk_t *,
3266     ip_recv_attr_t *, int *);
3267 extern boolean_t ip_input_local_options(mblk_t *, ipha_t *, ip_recv_attr_t *);
3268 extern mblk_t	*ip_input_fragment(mblk_t *, ipha_t *, ip_recv_attr_t *);
3269 extern mblk_t	*ip_input_fragment_v6(mblk_t *, ip6_t *, ip6_frag_t *, uint_t,
3270     ip_recv_attr_t *);
3271 extern void	ip_input_post_ipsec(mblk_t *, ip_recv_attr_t *);
3272 extern void	ip_fanout_v4(mblk_t *, ipha_t *, ip_recv_attr_t *);
3273 extern void	ip_fanout_v6(mblk_t *, ip6_t *, ip_recv_attr_t *);
3274 extern void	ip_fanout_proto_conn(conn_t *, mblk_t *, ipha_t *, ip6_t *,
3275     ip_recv_attr_t *);
3276 extern void	ip_fanout_proto_v4(mblk_t *, ipha_t *, ip_recv_attr_t *);
3277 extern void	ip_fanout_send_icmp_v4(mblk_t *, uint_t, uint_t,
3278     ip_recv_attr_t *);
3279 extern void	ip_fanout_udp_conn(conn_t *, mblk_t *, ipha_t *, ip6_t *,
3280     ip_recv_attr_t *);
3281 extern void	ip_fanout_udp_multi_v4(mblk_t *, ipha_t *, uint16_t, uint16_t,
3282     ip_recv_attr_t *);
3283 extern mblk_t	*zero_spi_check(mblk_t *, ip_recv_attr_t *);
3284 extern void	ip_build_hdrs_v4(uchar_t *, uint_t, const ip_pkt_t *, uint8_t);
3285 extern int	ip_find_hdr_v4(ipha_t *, ip_pkt_t *, boolean_t);
3286 extern int	ip_total_hdrs_len_v4(const ip_pkt_t *);
3287 
3288 extern mblk_t	*ip_accept_tcp(ill_t *, ill_rx_ring_t *, squeue_t *,
3289     mblk_t *, mblk_t **, uint_t *cnt);
3290 extern void	ip_rput_dlpi(ill_t *, mblk_t *);
3291 extern void	ip_rput_notdata(ill_t *, mblk_t *);
3292 
3293 extern void	ip_mib2_add_ip_stats(mib2_ipIfStatsEntry_t *,
3294 		    mib2_ipIfStatsEntry_t *);
3295 extern void	ip_mib2_add_icmp6_stats(mib2_ipv6IfIcmpEntry_t *,
3296 		    mib2_ipv6IfIcmpEntry_t *);
3297 extern void	ip_rput_other(ipsq_t *, queue_t *, mblk_t *, void *);
3298 extern ire_t	*ip_check_multihome(void *, ire_t *, ill_t *);
3299 extern void	ip_send_potential_redirect_v4(mblk_t *, ipha_t *, ire_t *,
3300     ip_recv_attr_t *);
3301 extern int	ip_set_destination_v4(ipaddr_t *, ipaddr_t, ipaddr_t,
3302     ip_xmit_attr_t *, iulp_t *, uint32_t, uint_t);
3303 extern int	ip_set_destination_v6(in6_addr_t *, const in6_addr_t *,
3304     const in6_addr_t *, ip_xmit_attr_t *, iulp_t *, uint32_t, uint_t);
3305 
3306 extern int	ip_output_simple(mblk_t *, ip_xmit_attr_t *);
3307 extern int	ip_output_simple_v4(mblk_t *, ip_xmit_attr_t *);
3308 extern int	ip_output_simple_v6(mblk_t *, ip_xmit_attr_t *);
3309 extern int	ip_output_options(mblk_t *, ipha_t *, ip_xmit_attr_t *,
3310     ill_t *);
3311 extern void	ip_output_local_options(ipha_t *, ip_stack_t *);
3312 
3313 extern ip_xmit_attr_t *conn_get_ixa(conn_t *, boolean_t);
3314 extern ip_xmit_attr_t *conn_get_ixa_tryhard(conn_t *, boolean_t);
3315 extern ip_xmit_attr_t *conn_replace_ixa(conn_t *, ip_xmit_attr_t *);
3316 extern ip_xmit_attr_t *conn_get_ixa_exclusive(conn_t *);
3317 extern ip_xmit_attr_t *ip_xmit_attr_duplicate(ip_xmit_attr_t *);
3318 extern void	ip_xmit_attr_replace_tsl(ip_xmit_attr_t *, ts_label_t *);
3319 extern void	ip_xmit_attr_restore_tsl(ip_xmit_attr_t *, cred_t *);
3320 boolean_t	ip_recv_attr_replace_label(ip_recv_attr_t *, ts_label_t *);
3321 extern void	ixa_inactive(ip_xmit_attr_t *);
3322 extern void	ixa_refrele(ip_xmit_attr_t *);
3323 extern boolean_t ixa_check_drain_insert(conn_t *, ip_xmit_attr_t *);
3324 extern void	ixa_cleanup(ip_xmit_attr_t *);
3325 extern void	ira_cleanup(ip_recv_attr_t *, boolean_t);
3326 extern void	ixa_safe_copy(ip_xmit_attr_t *, ip_xmit_attr_t *);
3327 
3328 extern int	conn_ip_output(mblk_t *, ip_xmit_attr_t *);
3329 extern boolean_t ip_output_verify_local(ip_xmit_attr_t *);
3330 extern mblk_t	*ip_output_process_local(mblk_t *, ip_xmit_attr_t *, boolean_t,
3331     boolean_t, conn_t *);
3332 
3333 extern int	conn_opt_get(conn_opt_arg_t *, t_scalar_t, t_scalar_t,
3334     uchar_t *);
3335 extern int	conn_opt_set(conn_opt_arg_t *, t_scalar_t, t_scalar_t, uint_t,
3336     uchar_t *, boolean_t, cred_t *);
3337 extern boolean_t	conn_same_as_last_v4(conn_t *, sin_t *);
3338 extern boolean_t	conn_same_as_last_v6(conn_t *, sin6_t *);
3339 extern int	conn_update_label(const conn_t *, const ip_xmit_attr_t *,
3340     const in6_addr_t *, ip_pkt_t *);
3341 
3342 extern int	ip_opt_set_multicast_group(conn_t *, t_scalar_t,
3343     uchar_t *, boolean_t, boolean_t);
3344 extern int	ip_opt_set_multicast_sources(conn_t *, t_scalar_t,
3345     uchar_t *, boolean_t, boolean_t);
3346 extern int	conn_getsockname(conn_t *, struct sockaddr *, uint_t *);
3347 extern int	conn_getpeername(conn_t *, struct sockaddr *, uint_t *);
3348 
3349 extern int	conn_build_hdr_template(conn_t *, uint_t, uint_t,
3350     const in6_addr_t *, const in6_addr_t *, uint32_t);
3351 extern mblk_t	*conn_prepend_hdr(ip_xmit_attr_t *, const ip_pkt_t *,
3352     const in6_addr_t *, const in6_addr_t *, uint8_t, uint32_t, uint_t,
3353     mblk_t *, uint_t, uint_t, uint32_t *, int *);
3354 extern void	ip_attr_newdst(ip_xmit_attr_t *);
3355 extern void	ip_attr_nexthop(const ip_pkt_t *, const ip_xmit_attr_t *,
3356     const in6_addr_t *, in6_addr_t *);
3357 extern int	conn_connect(conn_t *, iulp_t *, uint32_t);
3358 extern int	ip_attr_connect(const conn_t *, ip_xmit_attr_t *,
3359     const in6_addr_t *, const in6_addr_t *, const in6_addr_t *, in_port_t,
3360     in6_addr_t *, iulp_t *, uint32_t);
3361 extern int	conn_inherit_parent(conn_t *, conn_t *);
3362 
3363 extern void	conn_ixa_cleanup(conn_t *connp, void *arg);
3364 
3365 extern boolean_t conn_wantpacket(conn_t *, ip_recv_attr_t *, ipha_t *);
3366 extern uint_t	ip_type_v4(ipaddr_t, ip_stack_t *);
3367 extern uint_t	ip_type_v6(const in6_addr_t *, ip_stack_t *);
3368 
3369 extern void	ip_wput_nondata(queue_t *, mblk_t *);
3370 extern void	ip_wsrv(queue_t *);
3371 extern char	*ip_nv_lookup(nv_t *, int);
3372 extern boolean_t ip_local_addr_ok_v6(const in6_addr_t *, const in6_addr_t *);
3373 extern boolean_t ip_remote_addr_ok_v6(const in6_addr_t *, const in6_addr_t *);
3374 extern ipaddr_t ip_massage_options(ipha_t *, netstack_t *);
3375 extern ipaddr_t ip_net_mask(ipaddr_t);
3376 extern void	arp_bringup_done(ill_t *, int);
3377 extern void	arp_replumb_done(ill_t *, int);
3378 
3379 extern struct qinit iprinitv6;
3380 
3381 extern void	ipmp_init(ip_stack_t *);
3382 extern void	ipmp_destroy(ip_stack_t *);
3383 extern ipmp_grp_t *ipmp_grp_create(const char *, phyint_t *);
3384 extern void	ipmp_grp_destroy(ipmp_grp_t *);
3385 extern void	ipmp_grp_info(const ipmp_grp_t *, lifgroupinfo_t *);
3386 extern int	ipmp_grp_rename(ipmp_grp_t *, const char *);
3387 extern ipmp_grp_t *ipmp_grp_lookup(const char *, ip_stack_t *);
3388 extern int	ipmp_grp_vet_phyint(ipmp_grp_t *, phyint_t *);
3389 extern ipmp_illgrp_t *ipmp_illgrp_create(ill_t *);
3390 extern void	ipmp_illgrp_destroy(ipmp_illgrp_t *);
3391 extern ill_t	*ipmp_illgrp_add_ipif(ipmp_illgrp_t *, ipif_t *);
3392 extern void	ipmp_illgrp_del_ipif(ipmp_illgrp_t *, ipif_t *);
3393 extern ill_t	*ipmp_illgrp_next_ill(ipmp_illgrp_t *);
3394 extern ill_t	*ipmp_illgrp_hold_next_ill(ipmp_illgrp_t *);
3395 extern ill_t	*ipmp_illgrp_hold_cast_ill(ipmp_illgrp_t *);
3396 extern ill_t	*ipmp_illgrp_ipmp_ill(ipmp_illgrp_t *);
3397 extern void	ipmp_illgrp_refresh_mtu(ipmp_illgrp_t *);
3398 extern ipmp_arpent_t *ipmp_illgrp_create_arpent(ipmp_illgrp_t *,
3399     boolean_t, ipaddr_t, uchar_t *, size_t, uint16_t);
3400 extern void	ipmp_illgrp_destroy_arpent(ipmp_illgrp_t *, ipmp_arpent_t *);
3401 extern ipmp_arpent_t *ipmp_illgrp_lookup_arpent(ipmp_illgrp_t *, ipaddr_t *);
3402 extern void	ipmp_illgrp_refresh_arpent(ipmp_illgrp_t *);
3403 extern void	ipmp_illgrp_mark_arpent(ipmp_illgrp_t *, ipmp_arpent_t *);
3404 extern ill_t	*ipmp_illgrp_find_ill(ipmp_illgrp_t *, uchar_t *, uint_t);
3405 extern void	ipmp_illgrp_link_grp(ipmp_illgrp_t *, ipmp_grp_t *);
3406 extern int	ipmp_illgrp_unlink_grp(ipmp_illgrp_t *);
3407 extern uint_t	ipmp_ill_get_ipmp_ifindex(const ill_t *);
3408 extern void	ipmp_ill_join_illgrp(ill_t *, ipmp_illgrp_t *);
3409 extern void	ipmp_ill_leave_illgrp(ill_t *);
3410 extern ill_t	*ipmp_ill_hold_ipmp_ill(ill_t *);
3411 extern ill_t	*ipmp_ill_hold_xmit_ill(ill_t *, boolean_t);
3412 extern boolean_t ipmp_ill_is_active(ill_t *);
3413 extern void	ipmp_ill_refresh_active(ill_t *);
3414 extern void	ipmp_phyint_join_grp(phyint_t *, ipmp_grp_t *);
3415 extern void	ipmp_phyint_leave_grp(phyint_t *);
3416 extern void	ipmp_phyint_refresh_active(phyint_t *);
3417 extern ill_t	*ipmp_ipif_bound_ill(const ipif_t *);
3418 extern ill_t	*ipmp_ipif_hold_bound_ill(const ipif_t *);
3419 extern boolean_t ipmp_ipif_is_dataaddr(const ipif_t *);
3420 extern boolean_t ipmp_ipif_is_stubaddr(const ipif_t *);
3421 extern boolean_t ipmp_packet_is_probe(mblk_t *, ill_t *);
3422 extern void	ipmp_ncec_delete_nce(ncec_t *);
3423 extern void	ipmp_ncec_refresh_nce(ncec_t *);
3424 
3425 extern void	conn_drain_insert(conn_t *, idl_tx_list_t *);
3426 extern void	conn_setqfull(conn_t *, boolean_t *);
3427 extern void	conn_clrqfull(conn_t *, boolean_t *);
3428 extern int	conn_ipsec_length(conn_t *);
3429 extern ipaddr_t	ip_get_dst(ipha_t *);
3430 extern uint_t	ip_get_pmtu(ip_xmit_attr_t *);
3431 extern uint_t	ip_get_base_mtu(ill_t *, ire_t *);
3432 extern mblk_t *ip_output_attach_policy(mblk_t *, ipha_t *, ip6_t *,
3433     const conn_t *, ip_xmit_attr_t *);
3434 extern int	ipsec_out_extra_length(ip_xmit_attr_t *);
3435 extern int	ipsec_out_process(mblk_t *, ip_xmit_attr_t *);
3436 extern int	ip_output_post_ipsec(mblk_t *, ip_xmit_attr_t *);
3437 extern void	ipsec_out_to_in(ip_xmit_attr_t *, ill_t *ill,
3438     ip_recv_attr_t *);
3439 
3440 extern void	ire_cleanup(ire_t *);
3441 extern void	ire_inactive(ire_t *);
3442 extern boolean_t irb_inactive(irb_t *);
3443 extern ire_t	*ire_unlink(irb_t *);
3444 
3445 #ifdef DEBUG
3446 extern	boolean_t th_trace_ref(const void *, ip_stack_t *);
3447 extern	void	th_trace_unref(const void *);
3448 extern	void	th_trace_cleanup(const void *, boolean_t);
3449 extern	void	ire_trace_ref(ire_t *);
3450 extern	void	ire_untrace_ref(ire_t *);
3451 #endif
3452 
3453 extern int	ip_srcid_insert(const in6_addr_t *, zoneid_t, ip_stack_t *);
3454 extern int	ip_srcid_remove(const in6_addr_t *, zoneid_t, ip_stack_t *);
3455 extern void	ip_srcid_find_id(uint_t, in6_addr_t *, zoneid_t, netstack_t *);
3456 extern uint_t	ip_srcid_find_addr(const in6_addr_t *, zoneid_t, netstack_t *);
3457 
3458 extern uint8_t	ipoptp_next(ipoptp_t *);
3459 extern uint8_t	ipoptp_first(ipoptp_t *, ipha_t *);
3460 extern int	ip_opt_get_user(conn_t *, uchar_t *);
3461 extern int	ipsec_req_from_conn(conn_t *, ipsec_req_t *, int);
3462 extern int	ip_snmp_get(queue_t *q, mblk_t *mctl, int level, boolean_t);
3463 extern int	ip_snmp_set(queue_t *q, int, int, uchar_t *, int);
3464 extern void	ip_process_ioctl(ipsq_t *, queue_t *, mblk_t *, void *);
3465 extern void	ip_quiesce_conn(conn_t *);
3466 extern  void    ip_reprocess_ioctl(ipsq_t *, queue_t *, mblk_t *, void *);
3467 extern void	ip_ioctl_finish(queue_t *, mblk_t *, int, int, ipsq_t *);
3468 
3469 extern boolean_t ip_cmpbuf(const void *, uint_t, boolean_t, const void *,
3470     uint_t);
3471 extern boolean_t ip_allocbuf(void **, uint_t *, boolean_t, const void *,
3472     uint_t);
3473 extern void	ip_savebuf(void **, uint_t *, boolean_t, const void *, uint_t);
3474 
3475 extern boolean_t	ipsq_pending_mp_cleanup(ill_t *, conn_t *);
3476 extern void	conn_ioctl_cleanup(conn_t *);
3477 
3478 extern void	ip_unbind(conn_t *);
3479 
3480 extern void tnet_init(void);
3481 extern void tnet_fini(void);
3482 
3483 /*
3484  * Hook functions to enable cluster networking
3485  * On non-clustered systems these vectors must always be NULL.
3486  */
3487 extern int (*cl_inet_isclusterwide)(netstackid_t stack_id, uint8_t protocol,
3488     sa_family_t addr_family, uint8_t *laddrp, void *args);
3489 extern uint32_t (*cl_inet_ipident)(netstackid_t stack_id, uint8_t protocol,
3490     sa_family_t addr_family, uint8_t *laddrp, uint8_t *faddrp,
3491     void *args);
3492 extern int (*cl_inet_connect2)(netstackid_t stack_id, uint8_t protocol,
3493     boolean_t is_outgoing, sa_family_t addr_family, uint8_t *laddrp,
3494     in_port_t lport, uint8_t *faddrp, in_port_t fport, void *args);
3495 extern void (*cl_inet_getspi)(netstackid_t, uint8_t, uint8_t *, size_t,
3496     void *);
3497 extern void (*cl_inet_getspi)(netstackid_t stack_id, uint8_t protocol,
3498     uint8_t *ptr, size_t len, void *args);
3499 extern int (*cl_inet_checkspi)(netstackid_t stack_id, uint8_t protocol,
3500     uint32_t spi, void *args);
3501 extern void (*cl_inet_deletespi)(netstackid_t stack_id, uint8_t protocol,
3502     uint32_t spi, void *args);
3503 extern void (*cl_inet_idlesa)(netstackid_t, uint8_t, uint32_t,
3504     sa_family_t, in6_addr_t, in6_addr_t, void *);
3505 
3506 
3507 /* Hooks for CGTP (multirt routes) filtering module */
3508 #define	CGTP_FILTER_REV_1	1
3509 #define	CGTP_FILTER_REV_2	2
3510 #define	CGTP_FILTER_REV_3	3
3511 #define	CGTP_FILTER_REV		CGTP_FILTER_REV_3
3512 
3513 /* cfo_filter and cfo_filter_v6 hooks return values */
3514 #define	CGTP_IP_PKT_NOT_CGTP	0
3515 #define	CGTP_IP_PKT_PREMIUM	1
3516 #define	CGTP_IP_PKT_DUPLICATE	2
3517 
3518 /* Version 3 of the filter interface */
3519 typedef struct cgtp_filter_ops {
3520 	int	cfo_filter_rev;			/* CGTP_FILTER_REV_3 */
3521 	int	(*cfo_change_state)(netstackid_t, int);
3522 	int	(*cfo_add_dest_v4)(netstackid_t, ipaddr_t, ipaddr_t,
3523 		    ipaddr_t, ipaddr_t);
3524 	int	(*cfo_del_dest_v4)(netstackid_t, ipaddr_t, ipaddr_t);
3525 	int	(*cfo_add_dest_v6)(netstackid_t, in6_addr_t *, in6_addr_t *,
3526 		    in6_addr_t *, in6_addr_t *);
3527 	int	(*cfo_del_dest_v6)(netstackid_t, in6_addr_t *, in6_addr_t *);
3528 	int	(*cfo_filter)(netstackid_t, uint_t, mblk_t *);
3529 	int	(*cfo_filter_v6)(netstackid_t, uint_t, ip6_t *,
3530 		    ip6_frag_t *);
3531 } cgtp_filter_ops_t;
3532 
3533 #define	CGTP_MCAST_SUCCESS	1
3534 
3535 /*
3536  * The separate CGTP module needs this global symbol so that it
3537  * can check the version and determine whether to use the old or the new
3538  * version of the filtering interface.
3539  */
3540 extern int	ip_cgtp_filter_rev;
3541 
3542 extern int	ip_cgtp_filter_supported(void);
3543 extern int	ip_cgtp_filter_register(netstackid_t, cgtp_filter_ops_t *);
3544 extern int	ip_cgtp_filter_unregister(netstackid_t);
3545 extern int	ip_cgtp_filter_is_registered(netstackid_t);
3546 
3547 /*
3548  * rr_ring_state cycles in the order shown below from RR_FREE through
3549  * RR_FREE_IN_PROG and  back to RR_FREE.
3550  */
3551 typedef enum {
3552 	RR_FREE,			/* Free slot */
3553 	RR_SQUEUE_UNBOUND,		/* Ring's squeue is unbound */
3554 	RR_SQUEUE_BIND_INPROG,		/* Ring's squeue bind in progress */
3555 	RR_SQUEUE_BOUND,		/* Ring's squeue bound to cpu */
3556 	RR_FREE_INPROG			/* Ring is being freed */
3557 } ip_ring_state_t;
3558 
3559 #define	ILL_MAX_RINGS		256	/* Max num of rx rings we can manage */
3560 #define	ILL_POLLING		0x01	/* Polling in use */
3561 
3562 /*
3563  * These functions pointer types are exported by the mac/dls layer.
3564  * we need to duplicate the definitions here because we cannot
3565  * include mac/dls header files here.
3566  */
3567 typedef boolean_t		(*ip_mac_intr_disable_t)(void *);
3568 typedef void			(*ip_mac_intr_enable_t)(void *);
3569 typedef ip_mac_tx_cookie_t	(*ip_dld_tx_t)(void *, mblk_t *,
3570     uint64_t, uint16_t);
3571 typedef	void			(*ip_flow_enable_t)(void *, ip_mac_tx_cookie_t);
3572 typedef void			*(*ip_dld_callb_t)(void *,
3573     ip_flow_enable_t, void *);
3574 typedef boolean_t		(*ip_dld_fctl_t)(void *, ip_mac_tx_cookie_t);
3575 typedef int			(*ip_capab_func_t)(void *, uint_t,
3576     void *, uint_t);
3577 
3578 /*
3579  * POLLING README
3580  * sq_get_pkts() is called to pick packets from softring in poll mode. It
3581  * calls rr_rx to get the chain and process it with rr_ip_accept.
3582  * rr_rx = mac_soft_ring_poll() to pick packets
3583  * rr_ip_accept = ip_accept_tcp() to process packets
3584  */
3585 
3586 /*
3587  * XXX: With protocol, service specific squeues, they will have
3588  * specific acceptor functions.
3589  */
3590 typedef	mblk_t *(*ip_mac_rx_t)(void *, size_t);
3591 typedef mblk_t *(*ip_accept_t)(ill_t *, ill_rx_ring_t *,
3592     squeue_t *, mblk_t *, mblk_t **, uint_t *);
3593 
3594 /*
3595  * rr_intr_enable, rr_intr_disable, rr_rx_handle, rr_rx:
3596  * May be accessed while in the squeue AND after checking that SQS_POLL_CAPAB
3597  * is set.
3598  *
3599  * rr_ring_state: Protected by ill_lock.
3600  */
3601 struct ill_rx_ring {
3602 	ip_mac_intr_disable_t	rr_intr_disable; /* Interrupt disabling func */
3603 	ip_mac_intr_enable_t	rr_intr_enable;	/* Interrupt enabling func */
3604 	void			*rr_intr_handle; /* Handle interrupt funcs */
3605 	ip_mac_rx_t		rr_rx;		/* Driver receive function */
3606 	ip_accept_t		rr_ip_accept;	/* IP accept function */
3607 	void			*rr_rx_handle;	/* Handle for Rx ring */
3608 	squeue_t		*rr_sqp; /* Squeue the ring is bound to */
3609 	ill_t			*rr_ill;	/* back pointer to ill */
3610 	ip_ring_state_t		rr_ring_state;	/* State of this ring */
3611 };
3612 
3613 /*
3614  * IP - DLD direct function call capability
3615  * Suffixes, df - dld function, dh - dld handle,
3616  * cf - client (IP) function, ch - client handle
3617  */
3618 typedef struct ill_dld_direct_s {		/* DLD provided driver Tx */
3619 	ip_dld_tx_t		idd_tx_df;	/* str_mdata_fastpath_put */
3620 	void			*idd_tx_dh;	/* dld_str_t *dsp */
3621 	ip_dld_callb_t		idd_tx_cb_df;	/* mac_tx_srs_notify */
3622 	void			*idd_tx_cb_dh;	/* mac_client_handle_t *mch */
3623 	ip_dld_fctl_t		idd_tx_fctl_df;	/* mac_tx_is_flow_blocked */
3624 	void			*idd_tx_fctl_dh;	/* mac_client_handle */
3625 } ill_dld_direct_t;
3626 
3627 /* IP - DLD polling capability */
3628 typedef struct ill_dld_poll_s {
3629 	ill_rx_ring_t		idp_ring_tbl[ILL_MAX_RINGS];
3630 } ill_dld_poll_t;
3631 
3632 /* Describes ill->ill_dld_capab */
3633 struct ill_dld_capab_s {
3634 	ip_capab_func_t		idc_capab_df;	/* dld_capab_func */
3635 	void			*idc_capab_dh;	/* dld_str_t *dsp */
3636 	ill_dld_direct_t	idc_direct;
3637 	ill_dld_poll_t		idc_poll;
3638 };
3639 
3640 /*
3641  * IP squeues exports
3642  */
3643 extern boolean_t 	ip_squeue_fanout;
3644 
3645 #define	IP_SQUEUE_GET(hint) ip_squeue_random(hint)
3646 
3647 extern void ip_squeue_init(void (*)(squeue_t *));
3648 extern squeue_t	*ip_squeue_random(uint_t);
3649 extern squeue_t *ip_squeue_get(ill_rx_ring_t *);
3650 extern squeue_t *ip_squeue_getfree(pri_t);
3651 extern int ip_squeue_cpu_move(squeue_t *, processorid_t);
3652 extern void *ip_squeue_add_ring(ill_t *, void *);
3653 extern void ip_squeue_bind_ring(ill_t *, ill_rx_ring_t *, processorid_t);
3654 extern void ip_squeue_clean_ring(ill_t *, ill_rx_ring_t *);
3655 extern void ip_squeue_quiesce_ring(ill_t *, ill_rx_ring_t *);
3656 extern void ip_squeue_restart_ring(ill_t *, ill_rx_ring_t *);
3657 extern void ip_squeue_clean_all(ill_t *);
3658 extern boolean_t	ip_source_routed(ipha_t *, ip_stack_t *);
3659 
3660 extern void tcp_wput(queue_t *, mblk_t *);
3661 
3662 extern int	ip_fill_mtuinfo(conn_t *, ip_xmit_attr_t *,
3663     struct ip6_mtuinfo *);
3664 extern hook_t *ipobs_register_hook(netstack_t *, pfv_t);
3665 extern void ipobs_unregister_hook(netstack_t *, hook_t *);
3666 extern void ipobs_hook(mblk_t *, int, zoneid_t, zoneid_t, const ill_t *,
3667     ip_stack_t *);
3668 typedef void    (*ipsq_func_t)(ipsq_t *, queue_t *, mblk_t *, void *);
3669 
3670 extern void	dce_g_init(void);
3671 extern void	dce_g_destroy(void);
3672 extern void	dce_stack_init(ip_stack_t *);
3673 extern void	dce_stack_destroy(ip_stack_t *);
3674 extern void	dce_cleanup(uint_t, ip_stack_t *);
3675 extern dce_t	*dce_get_default(ip_stack_t *);
3676 extern dce_t	*dce_lookup_pkt(mblk_t *, ip_xmit_attr_t *, uint_t *);
3677 extern dce_t	*dce_lookup_v4(ipaddr_t, ip_stack_t *, uint_t *);
3678 extern dce_t	*dce_lookup_v6(const in6_addr_t *, uint_t, ip_stack_t *,
3679     uint_t *);
3680 extern dce_t	*dce_lookup_and_add_v4(ipaddr_t, ip_stack_t *);
3681 extern dce_t	*dce_lookup_and_add_v6(const in6_addr_t *, uint_t,
3682     ip_stack_t *);
3683 extern int	dce_update_uinfo_v4(ipaddr_t, iulp_t *, ip_stack_t *);
3684 extern int	dce_update_uinfo_v6(const in6_addr_t *, uint_t, iulp_t *,
3685     ip_stack_t *);
3686 extern int	dce_update_uinfo(const in6_addr_t *, uint_t, iulp_t *,
3687     ip_stack_t *);
3688 extern void	dce_increment_generation(dce_t *);
3689 extern void	dce_increment_all_generations(boolean_t, ip_stack_t *);
3690 extern void	dce_refrele(dce_t *);
3691 extern void	dce_refhold(dce_t *);
3692 extern void	dce_refrele_notr(dce_t *);
3693 extern void	dce_refhold_notr(dce_t *);
3694 mblk_t		*ip_snmp_get_mib2_ip_dce(queue_t *, mblk_t *, ip_stack_t *ipst);
3695 
3696 extern ip_laddr_t ip_laddr_verify_v4(ipaddr_t, zoneid_t,
3697     ip_stack_t *, boolean_t);
3698 extern ip_laddr_t ip_laddr_verify_v6(const in6_addr_t *, zoneid_t,
3699     ip_stack_t *, boolean_t, uint_t);
3700 extern int	ip_laddr_fanout_insert(conn_t *);
3701 
3702 extern boolean_t ip_verify_src(mblk_t *, ip_xmit_attr_t *, uint_t *);
3703 extern int	ip_verify_ire(mblk_t *, ip_xmit_attr_t *);
3704 
3705 extern mblk_t	*ip_xmit_attr_to_mblk(ip_xmit_attr_t *);
3706 extern boolean_t ip_xmit_attr_from_mblk(mblk_t *, ip_xmit_attr_t *);
3707 extern mblk_t	*ip_xmit_attr_free_mblk(mblk_t *);
3708 extern mblk_t	*ip_recv_attr_to_mblk(ip_recv_attr_t *);
3709 extern boolean_t ip_recv_attr_from_mblk(mblk_t *, ip_recv_attr_t *);
3710 extern mblk_t	*ip_recv_attr_free_mblk(mblk_t *);
3711 extern boolean_t ip_recv_attr_is_mblk(mblk_t *);
3712 
3713 /*
3714  * Squeue tags. Tags only need to be unique when the callback function is the
3715  * same to distinguish between different calls, but we use unique tags for
3716  * convenience anyway.
3717  */
3718 #define	SQTAG_IP_INPUT			1
3719 #define	SQTAG_TCP_INPUT_ICMP_ERR	2
3720 #define	SQTAG_TCP6_INPUT_ICMP_ERR	3
3721 #define	SQTAG_IP_TCP_INPUT		4
3722 #define	SQTAG_IP6_TCP_INPUT		5
3723 #define	SQTAG_IP_TCP_CLOSE		6
3724 #define	SQTAG_TCP_OUTPUT		7
3725 #define	SQTAG_TCP_TIMER			8
3726 #define	SQTAG_TCP_TIMEWAIT		9
3727 #define	SQTAG_TCP_ACCEPT_FINISH		10
3728 #define	SQTAG_TCP_ACCEPT_FINISH_Q0	11
3729 #define	SQTAG_TCP_ACCEPT_PENDING	12
3730 #define	SQTAG_TCP_LISTEN_DISCON		13
3731 #define	SQTAG_TCP_CONN_REQ_1		14
3732 #define	SQTAG_TCP_EAGER_BLOWOFF		15
3733 #define	SQTAG_TCP_EAGER_CLEANUP		16
3734 #define	SQTAG_TCP_EAGER_CLEANUP_Q0	17
3735 #define	SQTAG_TCP_CONN_IND		18
3736 #define	SQTAG_TCP_RSRV			19
3737 #define	SQTAG_TCP_ABORT_BUCKET		20
3738 #define	SQTAG_TCP_REINPUT		21
3739 #define	SQTAG_TCP_REINPUT_EAGER		22
3740 #define	SQTAG_TCP_INPUT_MCTL		23
3741 #define	SQTAG_TCP_RPUTOTHER		24
3742 #define	SQTAG_IP_PROTO_AGAIN		25
3743 #define	SQTAG_IP_FANOUT_TCP		26
3744 #define	SQTAG_IPSQ_CLEAN_RING		27
3745 #define	SQTAG_TCP_WPUT_OTHER		28
3746 #define	SQTAG_TCP_CONN_REQ_UNBOUND	29
3747 #define	SQTAG_TCP_SEND_PENDING		30
3748 #define	SQTAG_BIND_RETRY		31
3749 #define	SQTAG_UDP_FANOUT		32
3750 #define	SQTAG_UDP_INPUT			33
3751 #define	SQTAG_UDP_WPUT			34
3752 #define	SQTAG_UDP_OUTPUT		35
3753 #define	SQTAG_TCP_KSSL_INPUT		36
3754 #define	SQTAG_TCP_DROP_Q0		37
3755 #define	SQTAG_TCP_CONN_REQ_2		38
3756 #define	SQTAG_IP_INPUT_RX_RING		39
3757 #define	SQTAG_SQUEUE_CHANGE		40
3758 #define	SQTAG_CONNECT_FINISH		41
3759 #define	SQTAG_SYNCHRONOUS_OP		42
3760 #define	SQTAG_TCP_SHUTDOWN_OUTPUT	43
3761 #define	SQTAG_TCP_IXA_CLEANUP		44
3762 #define	SQTAG_TCP_SEND_SYNACK		45
3763 
3764 extern sin_t	sin_null;	/* Zero address for quick clears */
3765 extern sin6_t	sin6_null;	/* Zero address for quick clears */
3766 
3767 #endif	/* _KERNEL */
3768 
3769 #ifdef	__cplusplus
3770 }
3771 #endif
3772 
3773 #endif	/* _INET_IP_H */
3774