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