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