xref: /illumos-gate/usr/src/uts/common/netinet/in.h (revision e8249070)
1 /*
2  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
3  * Use is subject to license terms.
4  *
5  * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
6  * Copyright 2015, Joyent, Inc.
7  * Copyright 2020 OmniOS Community Edition (OmniOSce) Association.
8  * Copyright 2024 Oxide Computer Company
9  */
10 /*
11  * Copyright (c) 1982, 1986 Regents of the University of California.
12  * All rights reserved.
13  *
14  * Redistribution and use in source and binary forms are permitted
15  * provided that this notice is preserved and that due credit is given
16  * to the University of California at Berkeley. The name of the University
17  * may not be used to endorse or promote products derived from this
18  * software without specific prior written permission. This software
19  * is provided ``as is'' without express or implied warranty.
20  */
21 
22 /*
23  * Constants and structures defined by the internet system,
24  * according to following documents
25  *
26  * Internet ASSIGNED NUMBERS (RFC1700) and its successors:
27  *	http://www.iana.org/assignments/protocol-numbers
28  *	http://www.iana.org/assignments/port-numbers
29  * Basic Socket Interface Extensions for IPv6 (RFC2133 and its successors)
30  *
31  */
32 
33 #ifndef _NETINET_IN_H
34 #define	_NETINET_IN_H
35 
36 #include <sys/feature_tests.h>
37 
38 #ifdef	__cplusplus
39 extern "C" {
40 #endif
41 
42 #include <sys/types.h>
43 
44 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
45 #include <sys/socket_impl.h>
46 #endif	/* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
47 
48 #ifndef _SOCKLEN_T
49 #define	_SOCKLEN_T
50 
51 /*
52  * The socklen definitions are reproduced here from sys/socket.h so as to
53  * not introduce that namespace into existing users of netinet/in.h.
54  */
55 #if defined(_XPG4_2) && !defined(_XPG5) && !defined(_LP64)
56 typedef	size_t		socklen_t;
57 #else
58 typedef	uint32_t	socklen_t;
59 #endif	/* defined(_XPG4_2) && !defined(_XPG5) && !defined(_LP64) */
60 
61 #if defined(_XPG4_2) || defined(_BOOT)
62 typedef	socklen_t	*Psocklen_t;
63 #else
64 typedef	void		*Psocklen_t;
65 #endif	/* defined(_XPG4_2) || defined(_BOOT) */
66 
67 #endif /* _SOCKLEN_T */
68 
69 /*
70  * Symbols such as htonl() are required to be exposed through this file,
71  * per XNS Issue 5. This is achieved by inclusion of <sys/byteorder.h>
72  */
73 #if !defined(_XPG4_2) || defined(__EXTENSIONS__) || defined(_XPG5)
74 #include <sys/byteorder.h>
75 #endif
76 
77 #ifndef _IN_PORT_T
78 #define	_IN_PORT_T
79 typedef	uint16_t	in_port_t;
80 #endif
81 
82 /*
83  * Note: IPv4 address data structures usage conventions.
84  * The "in_addr_t" type below (required by Unix standards)
85  * is NOT a typedef of "struct in_addr" and violates the usual
86  * conventions where "struct <name>" and <name>_t are corresponding
87  * typedefs.
88  * To minimize confusion, kernel data structures/usage prefers use
89  * of "ipaddr_t" as atomic uint32_t type and avoid using "in_addr_t"
90  * The user level APIs continue to follow the historic popular
91  * practice of using "struct in_addr".
92  */
93 #ifndef _IN_ADDR_T
94 #define	_IN_ADDR_T
95 typedef	uint32_t	in_addr_t;
96 #endif
97 
98 #ifndef _IPADDR_T
99 #define	_IPADDR_T
100 typedef uint32_t ipaddr_t;
101 #endif
102 
103 #if !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__)
104 
105 struct in6_addr {
106 	union {
107 		/*
108 		 * Note: Static initalizers of "union" type assume
109 		 * the constant on the RHS is the type of the first member
110 		 * of union.
111 		 * To make static initializers (and efficient usage) work,
112 		 * the order of members exposed to user and kernel view of
113 		 * this data structure is different.
114 		 * User environment sees specified uint8_t type as first
115 		 * member whereas kernel sees most efficient type as
116 		 * first member.
117 		 */
118 #ifdef _KERNEL
119 		uint32_t	_S6_u32[4];	/* IPv6 address */
120 		uint16_t	_S6_u16[8];	/* IPv6 address */
121 		uint8_t		_S6_u8[16];	/* IPv6 address */
122 #else
123 		uint8_t		_S6_u8[16];	/* IPv6 address */
124 		uint16_t	_S6_u16[8];	/* IPv6 address */
125 		uint32_t	_S6_u32[4];	/* IPv6 address */
126 #endif
127 		uint32_t	__S6_align;	/* Align on 32 bit boundary */
128 	} _S6_un;
129 };
130 #define	s6_addr		_S6_un._S6_u8
131 
132 #ifdef _KERNEL
133 #define	s6_addr8	_S6_un._S6_u8
134 #define	s6_addr16	_S6_un._S6_u16
135 #define	s6_addr32	_S6_un._S6_u32
136 #endif
137 
138 typedef struct in6_addr in6_addr_t;
139 
140 #endif /* !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__) */
141 
142 #ifndef _SA_FAMILY_T
143 #define	_SA_FAMILY_T
144 typedef	uint16_t	sa_family_t;
145 #endif
146 
147 /*
148  * Protocols
149  *
150  * Some of these constant names are copied for the DTrace IP provider in
151  * usr/src/lib/libdtrace/common/{ip.d.in, ip.sed.in}, which should be kept
152  * in sync.
153  */
154 #define	IPPROTO_IP		0		/* dummy for IP */
155 #define	IPPROTO_HOPOPTS		0		/* Hop by hop header for IPv6 */
156 #define	IPPROTO_ICMP		1		/* control message protocol */
157 #define	IPPROTO_IGMP		2		/* group control protocol */
158 #define	IPPROTO_GGP		3		/* gateway^2 (deprecated) */
159 #define	IPPROTO_ENCAP		4		/* IP in IP encapsulation */
160 #define	IPPROTO_TCP		6		/* tcp */
161 #define	IPPROTO_EGP		8		/* exterior gateway protocol */
162 #define	IPPROTO_PUP		12		/* pup */
163 #define	IPPROTO_UDP		17		/* user datagram protocol */
164 #define	IPPROTO_IDP		22		/* xns idp */
165 #define	IPPROTO_IPV6		41		/* IPv6 encapsulated in IP */
166 #define	IPPROTO_ROUTING		43		/* Routing header for IPv6 */
167 #define	IPPROTO_FRAGMENT	44		/* Fragment header for IPv6 */
168 #define	IPPROTO_RSVP		46		/* rsvp */
169 #define	IPPROTO_ESP		50		/* IPsec Encap. Sec. Payload */
170 #define	IPPROTO_AH		51		/* IPsec Authentication Hdr. */
171 #define	IPPROTO_ICMPV6		58		/* ICMP for IPv6 */
172 #define	IPPROTO_NONE		59		/* No next header for IPv6 */
173 #define	IPPROTO_DSTOPTS		60		/* Destination options */
174 #define	IPPROTO_HELLO		63		/* "hello" routing protocol */
175 #define	IPPROTO_ND		77		/* UNOFFICIAL net disk proto */
176 #define	IPPROTO_EON		80		/* ISO clnp */
177 #define	IPPROTO_OSPF		89		/* OSPF */
178 #define	IPPROTO_PIM		103		/* PIM routing protocol */
179 #define	IPPROTO_SCTP		132		/* Stream Control */
180 						/* Transmission Protocol */
181 
182 #define	IPPROTO_RAW		255		/* raw IP packet */
183 #define	IPPROTO_MAX		256
184 
185 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
186 #define	PROTO_SDP		257		/* Sockets Direct Protocol */
187 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
188 
189 /*
190  * Port/socket numbers: network standard functions
191  *
192  * Entries should exist here for each port number compiled into an ON
193  * component, such as snoop.
194  */
195 #define	IPPORT_ECHO		7
196 #define	IPPORT_DISCARD		9
197 #define	IPPORT_SYSTAT		11
198 #define	IPPORT_DAYTIME		13
199 #define	IPPORT_NETSTAT		15
200 #define	IPPORT_CHARGEN		19
201 #define	IPPORT_FTP		21
202 #define	IPPORT_TELNET		23
203 #define	IPPORT_SMTP		25
204 #define	IPPORT_TIMESERVER	37
205 #define	IPPORT_NAMESERVER	42
206 #define	IPPORT_WHOIS		43
207 #define	IPPORT_DOMAIN		53
208 #define	IPPORT_MDNS		5353
209 #define	IPPORT_MTP		57
210 
211 /*
212  * Port/socket numbers: host specific functions
213  */
214 #define	IPPORT_BOOTPS		67
215 #define	IPPORT_BOOTPC		68
216 #define	IPPORT_TFTP		69
217 #define	IPPORT_RJE		77
218 #define	IPPORT_FINGER		79
219 #define	IPPORT_HTTP		80
220 #define	IPPORT_HTTP_ALT		8080
221 #define	IPPORT_TTYLINK		87
222 #define	IPPORT_SUPDUP		95
223 #define	IPPORT_NTP		123
224 #define	IPPORT_NETBIOS_NS	137
225 #define	IPPORT_NETBIOS_DGM	138
226 #define	IPPORT_NETBIOS_SSN	139
227 #define	IPPORT_LDAP		389
228 #define	IPPORT_SLP		427
229 #define	IPPORT_MIP		434
230 #define	IPPORT_SMB		445		/* a.k.a. microsoft-ds */
231 #define	IPPORT_VXLAN		4789
232 
233 /*
234  * Internet Key Exchange (IKE) ports
235  */
236 #define	IPPORT_IKE		500
237 #define	IPPORT_IKE_NATT		4500
238 
239 /*
240  * UNIX TCP sockets
241  */
242 #define	IPPORT_EXECSERVER	512
243 #define	IPPORT_LOGINSERVER	513
244 #define	IPPORT_CMDSERVER	514
245 #define	IPPORT_PRINTER		515
246 #define	IPPORT_EFSSERVER	520
247 
248 /*
249  * UNIX UDP sockets
250  */
251 #define	IPPORT_BIFFUDP		512
252 #define	IPPORT_WHOSERVER	513
253 #define	IPPORT_SYSLOG		514
254 #define	IPPORT_TALK		517
255 #define	IPPORT_ROUTESERVER	520
256 #define	IPPORT_RIPNG		521
257 
258 /*
259  * DHCPv6 UDP ports
260  */
261 #define	IPPORT_DHCPV6C		546
262 #define	IPPORT_DHCPV6S		547
263 
264 #define	IPPORT_SOCKS		1080
265 
266 /*
267  * Ports < IPPORT_RESERVED are reserved for
268  * privileged processes (e.g. root).
269  * Ports > IPPORT_USERRESERVED are reserved
270  * for servers, not necessarily privileged.
271  */
272 #define	IPPORT_RESERVED		1024
273 #define	IPPORT_USERRESERVED	5000
274 
275 #ifdef _KERNEL
276 #define	IPPORT_DYNAMIC_MIN	49152
277 #define	IPPORT_DYNAMIC_MAX	65535
278 #endif
279 
280 /*
281  * Link numbers
282  */
283 #define	IMPLINK_IP		155
284 #define	IMPLINK_LOWEXPER	156
285 #define	IMPLINK_HIGHEXPER	158
286 
287 /*
288  * IPv4 Internet address
289  *	This definition contains obsolete fields for compatibility
290  *	with SunOS 3.x and 4.2bsd.  The presence of subnets renders
291  *	divisions into fixed fields misleading at best.  New code
292  *	should use only the s_addr field.
293  */
294 
295 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
296 #define	_S_un_b	S_un_b
297 #define	_S_un_w	S_un_w
298 #define	_S_addr	S_addr
299 #define	_S_un	S_un
300 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
301 
302 struct in_addr {
303 	union {
304 		struct { uint8_t s_b1, s_b2, s_b3, s_b4; } _S_un_b;
305 		struct { uint16_t s_w1, s_w2; } _S_un_w;
306 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
307 		uint32_t _S_addr;
308 #else
309 		in_addr_t _S_addr;
310 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
311 	} _S_un;
312 #define	s_addr	_S_un._S_addr		/* should be used for all code */
313 #define	s_host	_S_un._S_un_b.s_b2	/* OBSOLETE: host on imp */
314 #define	s_net	_S_un._S_un_b.s_b1	/* OBSOLETE: network */
315 #define	s_imp	_S_un._S_un_w.s_w2	/* OBSOLETE: imp */
316 #define	s_impno	_S_un._S_un_b.s_b4	/* OBSOLETE: imp # */
317 #define	s_lh	_S_un._S_un_b.s_b3	/* OBSOLETE: logical host */
318 };
319 
320 /*
321  * Definitions of bits in internet address integers.
322  * On subnets, the decomposition of addresses to host and net parts
323  * is done according to subnet mask, not the masks here.
324  *
325  * Note that with the introduction of CIDR, IN_CLASSA, IN_CLASSB,
326  * IN_CLASSC, IN_CLASSD and IN_CLASSE macros have become "de-facto
327  * obsolete". IN_MULTICAST macro should be used to test if a address
328  * is a multicast address.
329  */
330 #define	IN_CLASSA(i)		(((i) & 0x80000000U) == 0)
331 #define	IN_CLASSA_NET		0xff000000U
332 #define	IN_CLASSA_NSHIFT	24
333 #define	IN_CLASSA_HOST		0x00ffffffU
334 #define	IN_CLASSA_MAX		128
335 
336 #define	IN_CLASSB(i)		(((i) & 0xc0000000U) == 0x80000000U)
337 #define	IN_CLASSB_NET		0xffff0000U
338 #define	IN_CLASSB_NSHIFT	16
339 #define	IN_CLASSB_HOST		0x0000ffffU
340 #define	IN_CLASSB_MAX		65536
341 
342 #define	IN_CLASSC(i)		(((i) & 0xe0000000U) == 0xc0000000U)
343 #define	IN_CLASSC_NET		0xffffff00U
344 #define	IN_CLASSC_NSHIFT	8
345 #define	IN_CLASSC_HOST		0x000000ffU
346 
347 #define	IN_CLASSD(i)		(((i) & 0xf0000000U) == 0xe0000000U)
348 #define	IN_CLASSD_NET		0xf0000000U	/* These aren't really  */
349 #define	IN_CLASSD_NSHIFT	28		/* net and host fields, but */
350 #define	IN_CLASSD_HOST		0x0fffffffU	/* routing needn't know */
351 
352 #define	IN_CLASSE(i)		(((i) & 0xf0000000U) == 0xf0000000U)
353 #define	IN_CLASSE_NET		0xffffffffU
354 
355 #define	IN_MULTICAST(i)		IN_CLASSD(i)
356 
357 /*
358  * We have removed CLASS E checks from the kernel
359  * But we preserve these defines for userland in order
360  * to avoid compile  breakage of some 3rd party piece of software
361  */
362 #ifndef _KERNEL
363 #define	IN_EXPERIMENTAL(i)	(((i) & 0xe0000000U) == 0xe0000000U)
364 #define	IN_BADCLASS(i)		(((i) & 0xf0000000U) == 0xf0000000U)
365 #endif
366 
367 #define	INADDR_ANY		0x00000000U
368 #define	INADDR_LOOPBACK		0x7F000001U
369 #define	INADDR_BROADCAST	0xffffffffU	/* must be masked */
370 #define	INADDR_NONE		0xffffffffU
371 
372 #define	INADDR_UNSPEC_GROUP	0xe0000000U	/* 224.0.0.0   */
373 #define	INADDR_ALLHOSTS_GROUP	0xe0000001U	/* 224.0.0.1   */
374 #define	INADDR_ALLRTRS_GROUP	0xe0000002U	/* 224.0.0.2   */
375 #define	INADDR_ALLRPTS_GROUP	0xe0000016U	/* 224.0.0.22, IGMPv3 */
376 #define	INADDR_MAX_LOCAL_GROUP	0xe00000ffU	/* 224.0.0.255 */
377 
378 /* Scoped IPv4 prefixes (in host byte-order) */
379 #define	IN_AUTOCONF_NET		0xa9fe0000U	/* 169.254/16 */
380 #define	IN_AUTOCONF_MASK	0xffff0000U
381 #define	IN_PRIVATE8_NET		0x0a000000U	/* 10/8 */
382 #define	IN_PRIVATE8_MASK	0xff000000U
383 #define	IN_PRIVATE12_NET	0xac100000U	/* 172.16/12 */
384 #define	IN_PRIVATE12_MASK	0xfff00000U
385 #define	IN_PRIVATE16_NET	0xc0a80000U	/* 192.168/16 */
386 #define	IN_PRIVATE16_MASK	0xffff0000U
387 
388 /* RFC 3927 IPv4 link local address (i in host byte-order) */
389 #define	IN_LINKLOCAL(i)		(((i) & IN_AUTOCONF_MASK) == IN_AUTOCONF_NET)
390 
391 /* Well known 6to4 Relay Router Anycast address defined in RFC 3068 */
392 #if !defined(_XPG4_2) || !defined(__EXTENSIONS__)
393 #define	INADDR_6TO4RRANYCAST	0xc0586301U	/* 192.88.99.1 */
394 #endif	/* !defined(_XPG4_2) || !defined(__EXTENSIONS__) */
395 
396 #define	IN_LOOPBACKNET		127			/* official! */
397 
398 /*
399  * Define a macro to stuff the loopback address into an Internet address
400  */
401 #if !defined(_XPG4_2) || !defined(__EXTENSIONS__)
402 #define	IN_SET_LOOPBACK_ADDR(a) \
403 	{ (a)->sin_addr.s_addr  = htonl(INADDR_LOOPBACK); \
404 	(a)->sin_family = AF_INET; }
405 #endif /* !defined(_XPG4_2) || !defined(__EXTENSIONS__) */
406 
407 /*
408  * IPv4 Socket address.
409  */
410 struct sockaddr_in {
411 	sa_family_t	sin_family;
412 	in_port_t	sin_port;
413 	struct	in_addr sin_addr;
414 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
415 	char		sin_zero[8];
416 #else
417 	unsigned char	sin_zero[8];
418 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
419 };
420 
421 #if !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__)
422 /*
423  * IPv6 socket address.
424  */
425 struct sockaddr_in6 {
426 	sa_family_t	sin6_family;
427 	in_port_t	sin6_port;
428 	uint32_t	sin6_flowinfo;
429 	struct in6_addr	sin6_addr;
430 	uint32_t	sin6_scope_id;  /* Depends on scope of sin6_addr */
431 	uint32_t	__sin6_src_id;	/* Impl. specific - UDP replies */
432 };
433 
434 /*
435  * Macros for accessing the traffic class and flow label fields from
436  * sin6_flowinfo.
437  * These are designed to be applied to a 32-bit value.
438  */
439 #ifdef _BIG_ENDIAN
440 
441 /* masks */
442 #define	IPV6_FLOWINFO_FLOWLABEL			0x000fffffU
443 #define	IPV6_FLOWINFO_TCLASS			0x0ff00000U
444 
445 #else /* _BIG_ENDIAN */
446 
447 /* masks */
448 #define	IPV6_FLOWINFO_FLOWLABEL			0xffff0f00U
449 #define	IPV6_FLOWINFO_TCLASS			0x0000f00fU
450 
451 #endif	/* _BIG_ENDIAN */
452 
453 /*
454  * Note: Macros IN6ADDR_ANY_INIT and IN6ADDR_LOOPBACK_INIT are for
455  * use as RHS of Static initializers of "struct in6_addr" (or in6_addr_t)
456  * only. They need to be different for User/Kernel versions because union
457  * component data structure is defined differently (it is identical at
458  * binary representation level).
459  *
460  * const struct in6_addr IN6ADDR_ANY_INIT;
461  * const struct in6_addr IN6ADDR_LOOPBACK_INIT;
462  */
463 
464 
465 #ifdef _KERNEL
466 #define	IN6ADDR_ANY_INIT		{ 0, 0, 0, 0 }
467 
468 #ifdef _BIG_ENDIAN
469 #define	IN6ADDR_LOOPBACK_INIT		{ 0, 0, 0, 0x00000001U }
470 #else /* _BIG_ENDIAN */
471 #define	IN6ADDR_LOOPBACK_INIT		{ 0, 0, 0, 0x01000000U }
472 #endif /* _BIG_ENDIAN */
473 
474 #else
475 
476 #define	IN6ADDR_ANY_INIT	    {	0, 0, 0, 0,	\
477 					0, 0, 0, 0,	\
478 					0, 0, 0, 0,	\
479 					0, 0, 0, 0 }
480 
481 #define	IN6ADDR_LOOPBACK_INIT	    {	0, 0, 0, 0,	\
482 					0, 0, 0, 0,	\
483 					0, 0, 0, 0,	\
484 					0, 0, 0, 0x1U }
485 #endif /* _KERNEL */
486 
487 /*
488  * RFC 2553 specifies the following macros. Their type is defined
489  * as "int" in the RFC but they only have boolean significance
490  * (zero or non-zero). For the purposes of our comment notation,
491  * we assume a hypothetical type "bool" defined as follows to
492  * write the prototypes assumed for macros in our comments better.
493  *
494  * typedef int bool;
495  */
496 
497 /*
498  * IN6 macros used to test for special IPv6 addresses
499  * (Mostly from spec)
500  *
501  * bool  IN6_IS_ADDR_UNSPECIFIED (const struct in6_addr *);
502  * bool  IN6_IS_ADDR_LOOPBACK    (const struct in6_addr *);
503  * bool  IN6_IS_ADDR_MULTICAST   (const struct in6_addr *);
504  * bool  IN6_IS_ADDR_LINKLOCAL   (const struct in6_addr *);
505  * bool  IN6_IS_ADDR_SITELOCAL   (const struct in6_addr *);
506  * bool  IN6_IS_ADDR_V4MAPPED    (const struct in6_addr *);
507  * bool  IN6_IS_ADDR_V4MAPPED_ANY(const struct in6_addr *); -- Not from RFC2553
508  * bool  IN6_IS_ADDR_V4COMPAT    (const struct in6_addr *);
509  * bool  IN6_IS_ADDR_MC_RESERVED (const struct in6_addr *); -- Not from RFC2553
510  * bool  IN6_IS_ADDR_MC_NODELOCAL(const struct in6_addr *);
511  * bool  IN6_IS_ADDR_MC_LINKLOCAL(const struct in6_addr *);
512  * bool  IN6_IS_ADDR_MC_SITELOCAL(const struct in6_addr *);
513  * bool  IN6_IS_ADDR_MC_ORGLOCAL (const struct in6_addr *);
514  * bool  IN6_IS_ADDR_MC_GLOBAL   (const struct in6_addr *);
515  * bool  IN6_IS_ADDR_6TO4	 (const struct in6_addr *); -- Not from RFC2553
516  * bool  IN6_ARE_6TO4_PREFIX_EQUAL(const struct in6_addr *,
517  *	     const struct in6_addr *);			    -- Not from RFC2553
518  * bool  IN6_IS_ADDR_LINKSCOPE	 (const struct in6addr  *); -- Not from RFC2553
519  */
520 
521 #define	IN6_IS_ADDR_UNSPECIFIED(addr) \
522 	(((addr)->_S6_un._S6_u32[3] == 0) && \
523 	((addr)->_S6_un._S6_u32[2] == 0) && \
524 	((addr)->_S6_un._S6_u32[1] == 0) && \
525 	((addr)->_S6_un._S6_u32[0] == 0))
526 
527 #ifdef _BIG_ENDIAN
528 #define	IN6_IS_ADDR_LOOPBACK(addr) \
529 	(((addr)->_S6_un._S6_u32[3] == 0x00000001) && \
530 	((addr)->_S6_un._S6_u32[2] == 0) && \
531 	((addr)->_S6_un._S6_u32[1] == 0) && \
532 	((addr)->_S6_un._S6_u32[0] == 0))
533 #else /* _BIG_ENDIAN */
534 #define	IN6_IS_ADDR_LOOPBACK(addr) \
535 	(((addr)->_S6_un._S6_u32[3] == 0x01000000) && \
536 	((addr)->_S6_un._S6_u32[2] == 0) && \
537 	((addr)->_S6_un._S6_u32[1] == 0) && \
538 	((addr)->_S6_un._S6_u32[0] == 0))
539 #endif /* _BIG_ENDIAN */
540 
541 #ifdef _BIG_ENDIAN
542 #define	IN6_IS_ADDR_MULTICAST(addr) \
543 	(((addr)->_S6_un._S6_u32[0] & 0xff000000) == 0xff000000)
544 #else /* _BIG_ENDIAN */
545 #define	IN6_IS_ADDR_MULTICAST(addr) \
546 	(((addr)->_S6_un._S6_u32[0] & 0x000000ff) == 0x000000ff)
547 #endif /* _BIG_ENDIAN */
548 
549 #ifdef _BIG_ENDIAN
550 #define	IN6_IS_ADDR_LINKLOCAL(addr) \
551 	(((addr)->_S6_un._S6_u32[0] & 0xffc00000) == 0xfe800000)
552 #else /* _BIG_ENDIAN */
553 #define	IN6_IS_ADDR_LINKLOCAL(addr) \
554 	(((addr)->_S6_un._S6_u32[0] & 0x0000c0ff) == 0x000080fe)
555 #endif /* _BIG_ENDIAN */
556 
557 #ifdef _BIG_ENDIAN
558 #define	IN6_IS_ADDR_SITELOCAL(addr) \
559 	(((addr)->_S6_un._S6_u32[0] & 0xffc00000) == 0xfec00000)
560 #else /* _BIG_ENDIAN */
561 #define	IN6_IS_ADDR_SITELOCAL(addr) \
562 	(((addr)->_S6_un._S6_u32[0] & 0x0000c0ff) == 0x0000c0fe)
563 #endif /* _BIG_ENDIAN */
564 
565 #ifdef _BIG_ENDIAN
566 #define	IN6_IS_ADDR_V4MAPPED(addr) \
567 	(((addr)->_S6_un._S6_u32[2] == 0x0000ffff) && \
568 	((addr)->_S6_un._S6_u32[1] == 0) && \
569 	((addr)->_S6_un._S6_u32[0] == 0))
570 #else  /* _BIG_ENDIAN */
571 #define	IN6_IS_ADDR_V4MAPPED(addr) \
572 	(((addr)->_S6_un._S6_u32[2] == 0xffff0000U) && \
573 	((addr)->_S6_un._S6_u32[1] == 0) && \
574 	((addr)->_S6_un._S6_u32[0] == 0))
575 #endif /* _BIG_ENDIAN */
576 
577 /*
578  * IN6_IS_ADDR_V4MAPPED - A IPv4 mapped INADDR_ANY
579  * Note: This macro is currently NOT defined in RFC2553 specification
580  * and not a standard macro that portable applications should use.
581  */
582 #ifdef _BIG_ENDIAN
583 #define	IN6_IS_ADDR_V4MAPPED_ANY(addr) \
584 	(((addr)->_S6_un._S6_u32[3] == 0) && \
585 	((addr)->_S6_un._S6_u32[2] == 0x0000ffff) && \
586 	((addr)->_S6_un._S6_u32[1] == 0) && \
587 	((addr)->_S6_un._S6_u32[0] == 0))
588 #else  /* _BIG_ENDIAN */
589 #define	IN6_IS_ADDR_V4MAPPED_ANY(addr) \
590 	(((addr)->_S6_un._S6_u32[3] == 0) && \
591 	((addr)->_S6_un._S6_u32[2] == 0xffff0000U) && \
592 	((addr)->_S6_un._S6_u32[1] == 0) && \
593 	((addr)->_S6_un._S6_u32[0] == 0))
594 #endif /* _BIG_ENDIAN */
595 
596 /* Exclude loopback and unspecified address */
597 #ifdef _BIG_ENDIAN
598 #define	IN6_IS_ADDR_V4COMPAT(addr) \
599 	(((addr)->_S6_un._S6_u32[2] == 0) && \
600 	((addr)->_S6_un._S6_u32[1] == 0) && \
601 	((addr)->_S6_un._S6_u32[0] == 0) && \
602 	!((addr)->_S6_un._S6_u32[3] == 0) && \
603 	!((addr)->_S6_un._S6_u32[3] == 0x00000001))
604 
605 #else /* _BIG_ENDIAN */
606 #define	IN6_IS_ADDR_V4COMPAT(addr) \
607 	(((addr)->_S6_un._S6_u32[2] == 0) && \
608 	((addr)->_S6_un._S6_u32[1] == 0) && \
609 	((addr)->_S6_un._S6_u32[0] == 0) && \
610 	!((addr)->_S6_un._S6_u32[3] == 0) && \
611 	!((addr)->_S6_un._S6_u32[3] == 0x01000000))
612 #endif /* _BIG_ENDIAN */
613 
614 /*
615  * Note:
616  * IN6_IS_ADDR_MC_RESERVED macro is currently NOT defined in RFC2553
617  * specification and not a standard macro that portable applications
618  * should use.
619  */
620 #ifdef _BIG_ENDIAN
621 #define	IN6_IS_ADDR_MC_RESERVED(addr) \
622 	(((addr)->_S6_un._S6_u32[0] & 0xff0f0000) == 0xff000000)
623 
624 #else  /* _BIG_ENDIAN */
625 #define	IN6_IS_ADDR_MC_RESERVED(addr) \
626 	(((addr)->_S6_un._S6_u32[0] & 0x00000fff) == 0x000000ff)
627 #endif /* _BIG_ENDIAN */
628 
629 #ifdef _BIG_ENDIAN
630 #define	IN6_IS_ADDR_MC_NODELOCAL(addr) \
631 	(((addr)->_S6_un._S6_u32[0] & 0xff0f0000) == 0xff010000)
632 #else  /* _BIG_ENDIAN */
633 #define	IN6_IS_ADDR_MC_NODELOCAL(addr) \
634 	(((addr)->_S6_un._S6_u32[0] & 0x00000fff) == 0x000001ff)
635 #endif /* _BIG_ENDIAN */
636 
637 #ifdef _BIG_ENDIAN
638 #define	IN6_IS_ADDR_MC_LINKLOCAL(addr) \
639 	(((addr)->_S6_un._S6_u32[0] & 0xff0f0000) == 0xff020000)
640 #else  /* _BIG_ENDIAN */
641 #define	IN6_IS_ADDR_MC_LINKLOCAL(addr) \
642 	(((addr)->_S6_un._S6_u32[0] & 0x00000fff) == 0x000002ff)
643 #endif /* _BIG_ENDIAN */
644 
645 #ifdef _BIG_ENDIAN
646 #define	IN6_IS_ADDR_MC_SITELOCAL(addr) \
647 	(((addr)->_S6_un._S6_u32[0] & 0xff0f0000) == 0xff050000)
648 #else  /* _BIG_ENDIAN */
649 #define	IN6_IS_ADDR_MC_SITELOCAL(addr) \
650 	(((addr)->_S6_un._S6_u32[0] & 0x00000fff) == 0x000005ff)
651 #endif /* _BIG_ENDIAN */
652 
653 #ifdef _BIG_ENDIAN
654 #define	IN6_IS_ADDR_MC_ORGLOCAL(addr) \
655 	(((addr)->_S6_un._S6_u32[0] & 0xff0f0000) == 0xff080000)
656 #else  /* _BIG_ENDIAN */
657 #define	IN6_IS_ADDR_MC_ORGLOCAL(addr) \
658 	(((addr)->_S6_un._S6_u32[0] & 0x00000fff) == 0x000008ff)
659 #endif /* _BIG_ENDIAN */
660 
661 #ifdef _BIG_ENDIAN
662 #define	IN6_IS_ADDR_MC_GLOBAL(addr) \
663 	(((addr)->_S6_un._S6_u32[0] & 0xff0f0000) == 0xff0e0000)
664 #else /* _BIG_ENDIAN */
665 #define	IN6_IS_ADDR_MC_GLOBAL(addr) \
666 	(((addr)->_S6_un._S6_u32[0] & 0x00000fff) == 0x00000eff)
667 #endif /* _BIG_ENDIAN */
668 
669 /*
670  * The IN6_IS_ADDR_MC_SOLICITEDNODE macro is not defined in any standard or
671  * RFC, and shouldn't be used by portable applications.  It is used to see
672  * if an address is a solicited-node multicast address, which is prefixed
673  * with ff02:0:0:0:0:1:ff00::/104.
674  */
675 #ifdef _BIG_ENDIAN
676 #define	IN6_IS_ADDR_MC_SOLICITEDNODE(addr)			\
677 	(((addr)->_S6_un._S6_u32[0] == 0xff020000) &&		\
678 	((addr)->_S6_un._S6_u32[1] == 0x00000000) &&		\
679 	((addr)->_S6_un._S6_u32[2] == 0x00000001) &&		\
680 	(((addr)->_S6_un._S6_u32[3] & 0xff000000) == 0xff000000))
681 #else
682 #define	IN6_IS_ADDR_MC_SOLICITEDNODE(addr)			\
683 	(((addr)->_S6_un._S6_u32[0] == 0x000002ff) &&		\
684 	((addr)->_S6_un._S6_u32[1] == 0x00000000) &&		\
685 	((addr)->_S6_un._S6_u32[2] == 0x01000000) &&		\
686 	(((addr)->_S6_un._S6_u32[3] & 0x000000ff) == 0x000000ff))
687 #endif
688 
689 /*
690  * Macros to a) test for 6to4 IPv6 address, and b) to test if two
691  * 6to4 addresses have the same /48 prefix, and, hence, are from the
692  * same 6to4 site.
693  */
694 
695 #ifdef _BIG_ENDIAN
696 #define	IN6_IS_ADDR_6TO4(addr) \
697 	(((addr)->_S6_un._S6_u32[0] & 0xffff0000) == 0x20020000)
698 #else /* _BIG_ENDIAN */
699 #define	IN6_IS_ADDR_6TO4(addr) \
700 	(((addr)->_S6_un._S6_u32[0] & 0x0000ffff) == 0x00000220)
701 #endif /* _BIG_ENDIAN */
702 
703 #define	IN6_ARE_6TO4_PREFIX_EQUAL(addr1, addr2) \
704 	(((addr1)->_S6_un._S6_u32[0] == (addr2)->_S6_un._S6_u32[0]) && \
705 	((addr1)->_S6_un._S6_u8[4] == (addr2)->_S6_un._S6_u8[4]) && \
706 	((addr1)->_S6_un._S6_u8[5] == (addr2)->_S6_un._S6_u8[5]))
707 
708 /*
709  * IN6_IS_ADDR_LINKSCOPE
710  * Identifies an address as being either link-local, link-local multicast or
711  * node-local multicast.  All types of addresses are considered to be unique
712  * within the scope of a given link.
713  */
714 #define	IN6_IS_ADDR_LINKSCOPE(addr) \
715 	(IN6_IS_ADDR_LINKLOCAL(addr) || IN6_IS_ADDR_MC_LINKLOCAL(addr) || \
716 	IN6_IS_ADDR_MC_NODELOCAL(addr))
717 
718 /*
719  * Useful utility macros for operations with IPv6 addresses
720  * Note: These macros are NOT defined in the RFC2553 or any other
721  * standard specification and are not standard macros that portable
722  * applications should use.
723  */
724 
725 /*
726  * IN6_V4MAPPED_TO_INADDR
727  * IN6_V4MAPPED_TO_IPADDR
728  *	Assign a IPv4-Mapped IPv6 address to an IPv4 address.
729  *	Note: These macros are NOT defined in RFC2553 or any other standard
730  *	specification and are not macros that portable applications should
731  *	use.
732  *
733  * void IN6_V4MAPPED_TO_INADDR(const in6_addr_t *v6, struct in_addr *v4);
734  * void IN6_V4MAPPED_TO_IPADDR(const in6_addr_t *v6, ipaddr_t v4);
735  *
736  */
737 #define	IN6_V4MAPPED_TO_INADDR(v6, v4) \
738 	((v4)->s_addr = (v6)->_S6_un._S6_u32[3])
739 #define	IN6_V4MAPPED_TO_IPADDR(v6, v4) \
740 	((v4) = (v6)->_S6_un._S6_u32[3])
741 
742 /*
743  * IN6_INADDR_TO_V4MAPPED
744  * IN6_IPADDR_TO_V4MAPPED
745  *	Assign a IPv4 address address to an IPv6 address as a IPv4-mapped
746  *	address.
747  *	Note: These macros are NOT defined in RFC2553 or any other standard
748  *	specification and are not macros that portable applications should
749  *	use.
750  *
751  * void IN6_INADDR_TO_V4MAPPED(const struct in_addr *v4, in6_addr_t *v6);
752  * void IN6_IPADDR_TO_V4MAPPED(const ipaddr_t v4, in6_addr_t *v6);
753  *
754  */
755 #ifdef _BIG_ENDIAN
756 #define	IN6_INADDR_TO_V4MAPPED(v4, v6) \
757 	((v6)->_S6_un._S6_u32[3] = (v4)->s_addr, \
758 	(v6)->_S6_un._S6_u32[2] = 0x0000ffff, \
759 	(v6)->_S6_un._S6_u32[1] = 0, \
760 	(v6)->_S6_un._S6_u32[0] = 0)
761 #define	IN6_IPADDR_TO_V4MAPPED(v4, v6) \
762 	((v6)->_S6_un._S6_u32[3] = (v4), \
763 	(v6)->_S6_un._S6_u32[2] = 0x0000ffff, \
764 	(v6)->_S6_un._S6_u32[1] = 0, \
765 	(v6)->_S6_un._S6_u32[0] = 0)
766 #else /* _BIG_ENDIAN */
767 #define	IN6_INADDR_TO_V4MAPPED(v4, v6) \
768 	((v6)->_S6_un._S6_u32[3] = (v4)->s_addr, \
769 	(v6)->_S6_un._S6_u32[2] = 0xffff0000U, \
770 	(v6)->_S6_un._S6_u32[1] = 0, \
771 	(v6)->_S6_un._S6_u32[0] = 0)
772 #define	IN6_IPADDR_TO_V4MAPPED(v4, v6) \
773 	((v6)->_S6_un._S6_u32[3] = (v4), \
774 	(v6)->_S6_un._S6_u32[2] = 0xffff0000U, \
775 	(v6)->_S6_un._S6_u32[1] = 0, \
776 	(v6)->_S6_un._S6_u32[0] = 0)
777 #endif /* _BIG_ENDIAN */
778 
779 /*
780  * IN6_6TO4_TO_V4ADDR
781  *	Extract the embedded IPv4 address from the prefix to a 6to4 IPv6
782  *      address.
783  *	Note: This macro is NOT defined in RFC2553 or any other standard
784  *	specification and is not a macro that portable applications should
785  *	use.
786  *	Note: we don't use the IPADDR form of the macro because we need
787  *	to do a bytewise copy; the V4ADDR in the 6to4 address is not
788  *	32-bit aligned.
789  *
790  * void IN6_6TO4_TO_V4ADDR(const in6_addr_t *v6, struct in_addr *v4);
791  *
792  */
793 #define	IN6_6TO4_TO_V4ADDR(v6, v4) \
794 	((v4)->_S_un._S_un_b.s_b1 = (v6)->_S6_un._S6_u8[2], \
795 	(v4)->_S_un._S_un_b.s_b2 = (v6)->_S6_un._S6_u8[3],  \
796 	(v4)->_S_un._S_un_b.s_b3 = (v6)->_S6_un._S6_u8[4],  \
797 	(v4)->_S_un._S_un_b.s_b4 = (v6)->_S6_un._S6_u8[5])
798 
799 /*
800  * IN6_V4ADDR_TO_6TO4
801  *	Given an IPv4 address and an IPv6 address for output, a 6to4 address
802  *	will be created from the IPv4 Address.
803  *	Note:  This method for creating 6to4 addresses is not standardized
804  *	outside of Solaris.  The newly created 6to4 address will be of the form
805  *	2002:<V4ADDR>:<SUBNETID>::<HOSTID>, where SUBNETID will equal 0 and
806  *	HOSTID will equal 1.
807  *
808  * void IN6_V4ADDR_TO_6TO4(const struct in_addr *v4, in6_addr_t *v6)
809  *
810  */
811 #ifdef _BIG_ENDIAN
812 #define	IN6_V4ADDR_TO_6TO4(v4, v6) \
813 	((v6)->_S6_un._S6_u8[0] = 0x20, \
814 	(v6)->_S6_un._S6_u8[1] = 0x02, \
815 	(v6)->_S6_un._S6_u8[2] = (v4)->_S_un._S_un_b.s_b1, \
816 	(v6)->_S6_un._S6_u8[3] = (v4)->_S_un._S_un_b.s_b2, \
817 	(v6)->_S6_un._S6_u8[4] = (v4)->_S_un._S_un_b.s_b3, \
818 	(v6)->_S6_un._S6_u8[5] = (v4)->_S_un._S_un_b.s_b4, \
819 	(v6)->_S6_un._S6_u8[6] = 0, \
820 	(v6)->_S6_un._S6_u8[7] = 0, \
821 	(v6)->_S6_un._S6_u32[2] = 0, \
822 	(v6)->_S6_un._S6_u32[3] = 0x00000001U)
823 #else
824 #define	IN6_V4ADDR_TO_6TO4(v4, v6) \
825 	((v6)->_S6_un._S6_u8[0] = 0x20, \
826 	(v6)->_S6_un._S6_u8[1] = 0x02, \
827 	(v6)->_S6_un._S6_u8[2] = (v4)->_S_un._S_un_b.s_b1, \
828 	(v6)->_S6_un._S6_u8[3] = (v4)->_S_un._S_un_b.s_b2, \
829 	(v6)->_S6_un._S6_u8[4] = (v4)->_S_un._S_un_b.s_b3, \
830 	(v6)->_S6_un._S6_u8[5] = (v4)->_S_un._S_un_b.s_b4, \
831 	(v6)->_S6_un._S6_u8[6] = 0, \
832 	(v6)->_S6_un._S6_u8[7] = 0, \
833 	(v6)->_S6_un._S6_u32[2] = 0, \
834 	(v6)->_S6_un._S6_u32[3] = 0x01000000U)
835 #endif /* _BIG_ENDIAN */
836 
837 /*
838  * IN6_ARE_ADDR_EQUAL (defined in RFC2292)
839  *	 Compares if IPv6 addresses are equal.
840  * Note: Compares in order of high likelyhood of a miss so we minimize
841  * compares. (Current heuristic order, compare in reverse order of
842  * uint32_t units)
843  *
844  * bool  IN6_ARE_ADDR_EQUAL(const struct in6_addr *,
845  *			    const struct in6_addr *);
846  */
847 #define	IN6_ARE_ADDR_EQUAL(addr1, addr2) \
848 	(((addr1)->_S6_un._S6_u32[3] == (addr2)->_S6_un._S6_u32[3]) && \
849 	((addr1)->_S6_un._S6_u32[2] == (addr2)->_S6_un._S6_u32[2]) && \
850 	((addr1)->_S6_un._S6_u32[1] == (addr2)->_S6_un._S6_u32[1]) && \
851 	((addr1)->_S6_un._S6_u32[0] == (addr2)->_S6_un._S6_u32[0]))
852 
853 /*
854  * IN6_ARE_PREFIXEDADDR_EQUAL (not defined in RFCs)
855  *	Compares if prefixed parts of IPv6 addresses are equal.
856  *
857  * uint32_t IN6_MASK_FROM_PREFIX(int, int);
858  * bool     IN6_ARE_PREFIXEDADDR_EQUAL(const struct in6_addr *,
859  *				       const struct in6_addr *,
860  *				       int);
861  */
862 #define	IN6_MASK_FROM_PREFIX(qoctet, prefix) \
863 	((((qoctet) + 1) * 32 < (prefix)) ? 0xFFFFFFFFu : \
864 	((((qoctet) * 32) >= (prefix)) ? 0x00000000u : \
865 	0xFFFFFFFFu << (((qoctet) + 1) * 32 - (prefix))))
866 
867 #define	IN6_ARE_PREFIXEDADDR_EQUAL(addr1, addr2, prefix) \
868 	(((ntohl((addr1)->_S6_un._S6_u32[0]) & \
869 	IN6_MASK_FROM_PREFIX(0, prefix)) == \
870 	(ntohl((addr2)->_S6_un._S6_u32[0]) & \
871 	IN6_MASK_FROM_PREFIX(0, prefix))) && \
872 	((ntohl((addr1)->_S6_un._S6_u32[1]) & \
873 	IN6_MASK_FROM_PREFIX(1, prefix)) == \
874 	(ntohl((addr2)->_S6_un._S6_u32[1]) & \
875 	IN6_MASK_FROM_PREFIX(1, prefix))) && \
876 	((ntohl((addr1)->_S6_un._S6_u32[2]) & \
877 	IN6_MASK_FROM_PREFIX(2, prefix)) == \
878 	(ntohl((addr2)->_S6_un._S6_u32[2]) & \
879 	IN6_MASK_FROM_PREFIX(2, prefix))) && \
880 	((ntohl((addr1)->_S6_un._S6_u32[3]) & \
881 	IN6_MASK_FROM_PREFIX(3, prefix)) == \
882 	(ntohl((addr2)->_S6_un._S6_u32[3]) & \
883 	IN6_MASK_FROM_PREFIX(3, prefix))))
884 
885 #endif /* !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__) */
886 
887 
888 /*
889  * Options for use with [gs]etsockopt at the IP level.
890  *
891  * Note: Some of the IP_ namespace has conflict with and
892  * and is exposed through <xti.h>. (It also requires exposing
893  * options not implemented). The options with potential
894  * for conflicts use #ifndef guards.
895  */
896 #ifndef IP_OPTIONS
897 #define	IP_OPTIONS	1	/* set/get IP per-packet options   */
898 #endif
899 
900 #define	IP_HDRINCL	2	/* int; header is included with data (raw) */
901 
902 #ifndef IP_TOS
903 #define	IP_TOS		3	/* int; IP type of service and precedence */
904 #endif
905 
906 #ifndef IP_TTL
907 #define	IP_TTL		4	/* int; IP time to live */
908 #endif
909 
910 #define	IP_RECVOPTS	0x5	/* int; receive all IP options w/datagram */
911 #define	IP_RECVRETOPTS	0x6	/* int; receive IP options for response */
912 #define	IP_RECVDSTADDR	0x7	/* int; receive IP dst addr w/datagram */
913 #define	IP_RETOPTS	0x8	/* ip_opts; set/get IP per-packet options */
914 #define	IP_RECVIF	0x9	/* int; receive the inbound interface index */
915 #define	IP_RECVSLLA	0xa	/* sockaddr_dl; get source link layer address */
916 #define	IP_RECVTTL	0xb	/* uint8_t; get TTL for inbound packet */
917 #define	IP_RECVTOS	0xc	/* uint8_t; get TOS for inbound packet */
918 
919 #define	IP_MULTICAST_IF		0x10	/* set/get IP multicast interface  */
920 #define	IP_MULTICAST_TTL	0x11	/* set/get IP multicast timetolive */
921 #define	IP_MULTICAST_LOOP	0x12	/* set/get IP multicast loopback   */
922 #define	IP_ADD_MEMBERSHIP	0x13	/* add	an IP group membership	   */
923 #define	IP_DROP_MEMBERSHIP	0x14	/* drop an IP group membership	   */
924 #define	IP_BLOCK_SOURCE		0x15	/* block   mcast pkts from source  */
925 #define	IP_UNBLOCK_SOURCE	0x16	/* unblock mcast pkts from source  */
926 #define	IP_ADD_SOURCE_MEMBERSHIP  0x17	/* add  mcast group/source pair	   */
927 #define	IP_DROP_SOURCE_MEMBERSHIP 0x18	/* drop mcast group/source pair	   */
928 #define	IP_NEXTHOP		0x19	/* send directly to next hop	   */
929 /*
930  * IP_PKTINFO and IP_RECVPKTINFO have same value. Size of argument passed in
931  * is used to differentiate b/w the two.
932  */
933 #define	IP_PKTINFO		0x1a	/* specify src address and/or index */
934 #define	IP_RECVPKTINFO		0x1a	/* recv dest/matched addr and index */
935 #define	IP_DONTFRAG		0x1b	/* don't fragment packets */
936 #define	IP_MINTTL		0x1c	/* minimum acceptable TTL */
937 
938 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
939 /*
940  * Different preferences that can be requested from IPSEC protocols.
941  */
942 #define	IP_SEC_OPT		0x22	/* Used to set IPSEC options */
943 #define	IPSEC_PREF_NEVER	0x01
944 #define	IPSEC_PREF_REQUIRED	0x02
945 #define	IPSEC_PREF_UNIQUE	0x04
946 /*
947  * This can be used with the setsockopt() call to set per socket security
948  * options. When the application uses per-socket API, we will reflect
949  * the request on both outbound and inbound packets.
950  */
951 
952 typedef struct ipsec_req {
953 	uint_t		ipsr_ah_req;		/* AH request */
954 	uint_t		ipsr_esp_req;		/* ESP request */
955 	uint_t		ipsr_self_encap_req;	/* Self-Encap request */
956 	uint8_t		ipsr_auth_alg;		/* Auth algs for AH */
957 	uint8_t		ipsr_esp_alg;		/* Encr algs for ESP */
958 	uint8_t		ipsr_esp_auth_alg;	/* Auth algs for ESP */
959 } ipsec_req_t;
960 
961 /*
962  * MCAST_* options are protocol-independent.  The actual definitions
963  * are with the v6 options below; this comment is here to note the
964  * namespace usage.
965  *
966  * #define	MCAST_JOIN_GROUP	0x29
967  * #define	MCAST_LEAVE_GROUP	0x2a
968  * #define	MCAST_BLOCK_SOURCE	0x2b
969  * #define	MCAST_UNBLOCK_SOURCE	0x2c
970  * #define	MCAST_JOIN_SOURCE_GROUP	0x2d
971  * #define	MCAST_LEAVE_SOURCE_GROUP 0x2e
972  */
973 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
974 
975 /*
976  * SunOS private (potentially not portable) IP_ option names
977  */
978 #define	IP_BOUND_IF		0x41	/* bind socket to an ifindex	   */
979 #define	IP_UNSPEC_SRC		0x42	/* use unspecified source address  */
980 #define	IP_BROADCAST_TTL	0x43	/* use specific TTL for broadcast  */
981 /* can be reused		0x44 */
982 #define	IP_DHCPINIT_IF		0x45	/* accept all unicast DHCP traffic */
983 
984 /*
985  * Option values and names (when !_XPG5) shared with <xti_inet.h>
986  */
987 #ifndef IP_REUSEADDR
988 #define	IP_REUSEADDR		0x104
989 #endif
990 
991 #ifndef IP_DONTROUTE
992 #define	IP_DONTROUTE		0x105
993 #endif
994 
995 #ifndef IP_BROADCAST
996 #define	IP_BROADCAST		0x106
997 #endif
998 
999 /*
1000  * The following option values are reserved by <xti_inet.h>
1001  *
1002  * T_IP_OPTIONS	0x107	 -  IP per-packet options
1003  * T_IP_TOS	0x108	 -  IP per packet type of service
1004  */
1005 
1006 /*
1007  * Default value constants for multicast attributes controlled by
1008  * IP*_MULTICAST_LOOP and IP*_MULTICAST_{TTL,HOPS} options.
1009  */
1010 #define	IP_DEFAULT_MULTICAST_TTL  1	/* normally limit m'casts to 1 hop */
1011 #define	IP_DEFAULT_MULTICAST_LOOP 1	/* normally hear sends if a member */
1012 
1013 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
1014 /*
1015  * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
1016  */
1017 struct ip_mreq {
1018 	struct in_addr	imr_multiaddr;	/* IP multicast address of group */
1019 	struct in_addr	imr_interface;	/* local IP address of interface */
1020 };
1021 
1022 /*
1023  * Argument structure for IP_BLOCK_SOURCE, IP_UNBLOCK_SOURCE,
1024  * IP_ADD_SOURCE_MEMBERSHIP, and IP_DROP_SOURCE_MEMBERSHIP.
1025  */
1026 struct ip_mreq_source {
1027 	struct in_addr	imr_multiaddr;	/* IP address of group */
1028 	struct in_addr	imr_sourceaddr;	/* IP address of source */
1029 	struct in_addr	imr_interface;	/* IP address of interface */
1030 };
1031 
1032 /*
1033  * Argument structure for IPV6_JOIN_GROUP and IPV6_LEAVE_GROUP on
1034  * IPv6 addresses.
1035  */
1036 struct ipv6_mreq {
1037 	struct in6_addr	ipv6mr_multiaddr;	/* IPv6 multicast addr */
1038 	unsigned int	ipv6mr_interface;	/* interface index */
1039 };
1040 
1041 /*
1042  * Use #pragma pack() construct to force 32-bit alignment on amd64.
1043  * This is needed to keep the structure size and offsets consistent
1044  * between a 32-bit app and the 64-bit amd64 kernel in structures
1045  * where 64-bit alignment would create gaps (in this case, structures
1046  * which have a uint32_t followed by a struct sockaddr_storage).
1047  */
1048 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
1049 #pragma pack(4)
1050 #endif
1051 
1052 /*
1053  * Argument structure for MCAST_JOIN_GROUP and MCAST_LEAVE_GROUP.
1054  */
1055 struct group_req {
1056 	uint32_t		gr_interface;	/* interface index */
1057 	struct sockaddr_storage	gr_group;	/* group address */
1058 };
1059 
1060 /*
1061  * Argument structure for MCAST_BLOCK_SOURCE, MCAST_UNBLOCK_SOURCE,
1062  * MCAST_JOIN_SOURCE_GROUP, MCAST_LEAVE_SOURCE_GROUP.
1063  */
1064 struct group_source_req {
1065 	uint32_t		gsr_interface;	/* interface index */
1066 	struct sockaddr_storage	gsr_group;	/* group address */
1067 	struct sockaddr_storage	gsr_source;	/* source address */
1068 };
1069 
1070 /*
1071  * Argument for SIOC[GS]MSFILTER ioctls
1072  */
1073 struct group_filter {
1074 	uint32_t		gf_interface;	/* interface index */
1075 	struct sockaddr_storage	gf_group;	/* multicast address */
1076 	uint32_t		gf_fmode;	/* filter mode */
1077 	uint32_t		gf_numsrc;	/* number of sources */
1078 	struct sockaddr_storage	gf_slist[1];	/* source address */
1079 };
1080 
1081 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
1082 #pragma pack()
1083 #endif
1084 
1085 #define	GROUP_FILTER_SIZE(numsrc) \
1086 	(sizeof (struct group_filter) - sizeof (struct sockaddr_storage) \
1087 	+ (numsrc) * sizeof (struct sockaddr_storage))
1088 
1089 /*
1090  * Argument for SIOC[GS]IPMSFILTER ioctls (IPv4-specific)
1091  */
1092 struct ip_msfilter {
1093 	struct in_addr	imsf_multiaddr;	/* IP multicast address of group */
1094 	struct in_addr	imsf_interface;	/* local IP address of interface */
1095 	uint32_t	imsf_fmode;	/* filter mode */
1096 	uint32_t	imsf_numsrc;	/* number of sources in src_list */
1097 	struct in_addr	imsf_slist[1];	/* start of source list */
1098 };
1099 
1100 #define	IP_MSFILTER_SIZE(numsrc) \
1101 	(sizeof (struct ip_msfilter) - sizeof (struct in_addr) \
1102 	+ (numsrc) * sizeof (struct in_addr))
1103 
1104 /*
1105  * Multicast source filter manipulation functions in libsocket;
1106  * defined in RFC 3678.
1107  */
1108 int setsourcefilter(int, uint32_t, struct sockaddr *, socklen_t, uint32_t,
1109 			uint_t, struct sockaddr_storage *);
1110 
1111 int getsourcefilter(int, uint32_t, struct sockaddr *, socklen_t, uint32_t *,
1112 			uint_t *, struct sockaddr_storage *);
1113 
1114 int setipv4sourcefilter(int, struct in_addr, struct in_addr, uint32_t,
1115 			uint32_t, struct in_addr *);
1116 
1117 int getipv4sourcefilter(int, struct in_addr, struct in_addr, uint32_t *,
1118 			uint32_t *, struct in_addr *);
1119 
1120 /*
1121  * Definitions needed for [gs]etsourcefilter(), [gs]etipv4sourcefilter()
1122  */
1123 #define	MCAST_INCLUDE	1
1124 #define	MCAST_EXCLUDE	2
1125 
1126 /*
1127  * Argument struct for IP_PKTINFO option
1128  */
1129 typedef struct in_pktinfo {
1130 	unsigned int		ipi_ifindex;	/* send/recv interface index */
1131 	struct in_addr		ipi_spec_dst;	/* matched source address */
1132 	struct in_addr		ipi_addr;	/* src/dst address in IP hdr */
1133 } in_pktinfo_t;
1134 
1135 /*
1136  * Argument struct for IPV6_PKTINFO option
1137  */
1138 struct in6_pktinfo {
1139 	struct in6_addr		ipi6_addr;	/* src/dst IPv6 address */
1140 	unsigned int		ipi6_ifindex;	/* send/recv interface index */
1141 };
1142 
1143 /*
1144  * Argument struct for IPV6_MTUINFO option
1145  */
1146 struct ip6_mtuinfo {
1147 	struct sockaddr_in6	ip6m_addr; /* dst address including zone ID */
1148 	uint32_t		ip6m_mtu;  /* path MTU in host byte order */
1149 };
1150 
1151 /*
1152  * IPv6 routing header types
1153  */
1154 #define	IPV6_RTHDR_TYPE_0	0
1155 
1156 extern socklen_t inet6_rth_space(int type, int segments);
1157 extern void *inet6_rth_init(void *bp, socklen_t bp_len, int type, int segments);
1158 extern int inet6_rth_add(void *bp, const struct in6_addr *addr);
1159 extern int inet6_rth_reverse(const void *in, void *out);
1160 extern int inet6_rth_segments(const void *bp);
1161 extern struct in6_addr *inet6_rth_getaddr(const void *bp, int index);
1162 
1163 extern int inet6_opt_init(void *extbuf, socklen_t extlen);
1164 extern int inet6_opt_append(void *extbuf, socklen_t extlen, int offset,
1165 	uint8_t type, socklen_t len, uint_t align, void **databufp);
1166 extern int inet6_opt_finish(void *extbuf, socklen_t extlen, int offset);
1167 extern int inet6_opt_set_val(void *databuf, int offset, void *val,
1168 	socklen_t vallen);
1169 extern int inet6_opt_next(void *extbuf, socklen_t extlen, int offset,
1170 	uint8_t *typep, socklen_t *lenp, void **databufp);
1171 extern int inet6_opt_find(void *extbufp, socklen_t extlen, int offset,
1172 	uint8_t type, socklen_t *lenp, void **databufp);
1173 extern int inet6_opt_get_val(void *databuf, int offset, void *val,
1174 	socklen_t vallen);
1175 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
1176 
1177 /*
1178  * Argument structure for IP_ADD_PROXY_ADDR.
1179  * Note that this is an unstable, experimental interface. It may change
1180  * later. Don't use it unless you know what it is.
1181  */
1182 typedef struct {
1183 	struct in_addr	in_prefix_addr;
1184 	unsigned int	in_prefix_len;
1185 } in_prefix_t;
1186 
1187 
1188 #if !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__)
1189 /*
1190  * IPv6 options
1191  */
1192 #define	IPV6_UNICAST_HOPS	0x5	/* hop limit value for unicast */
1193 					/* packets. */
1194 					/* argument type: uint_t */
1195 #define	IPV6_MULTICAST_IF	0x6	/* outgoing interface for */
1196 					/* multicast packets. */
1197 					/* argument type: struct in6_addr */
1198 #define	IPV6_MULTICAST_HOPS	0x7	/* hop limit value to use for */
1199 					/* multicast packets. */
1200 					/* argument type: uint_t */
1201 #define	IPV6_MULTICAST_LOOP	0x8	/* enable/disable delivery of */
1202 					/* multicast packets on same socket. */
1203 					/* argument type: uint_t */
1204 #define	IPV6_JOIN_GROUP		0x9	/* join an IPv6 multicast group. */
1205 					/* argument type: struct ipv6_mreq */
1206 #define	IPV6_LEAVE_GROUP	0xa	/* leave an IPv6 multicast group */
1207 					/* argument type: struct ipv6_mreq */
1208 
1209 /*
1210  * Other XPG6 constants.
1211  */
1212 #define	INET_ADDRSTRLEN		16	/* max len IPv4 addr in ascii dotted */
1213 					/* decimal notation. */
1214 #define	INET6_ADDRSTRLEN	46	/* max len of IPv6 addr in ascii */
1215 					/* standard colon-hex notation. */
1216 
1217 #endif /* !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__) */
1218 
1219 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
1220 
1221 /*
1222  * IPV6_ADD_MEMBERSHIP and IPV6_DROP_MEMBERSHIP are being kept
1223  * for backward compatibility. They have the same meaning as IPV6_JOIN_GROUP
1224  * and IPV6_LEAVE_GROUP respectively.
1225  */
1226 #define	IPV6_ADD_MEMBERSHIP	0x9	/* join an IPv6 multicast group. */
1227 					/* argument type: struct ipv6_mreq */
1228 #define	IPV6_DROP_MEMBERSHIP	0xa	/* leave an IPv6 multicast group */
1229 					/* argument type: struct ipv6_mreq */
1230 
1231 #define	IPV6_PKTINFO		0xb	/* addr plus interface index */
1232 					/* arg type: "struct in6_pktingo" - */
1233 #define	IPV6_HOPLIMIT		0xc	/* hoplimit for datagram */
1234 #define	IPV6_NEXTHOP		0xd	/* next hop address  */
1235 #define	IPV6_HOPOPTS		0xe	/* hop by hop options */
1236 #define	IPV6_DSTOPTS		0xf	/* destination options - after */
1237 					/* the routing header */
1238 #define	IPV6_RTHDR		0x10	/* routing header  */
1239 #define	IPV6_RTHDRDSTOPTS	0x11	/* destination options - before */
1240 					/* the routing header */
1241 #define	IPV6_RECVPKTINFO	0x12	/* enable/disable IPV6_PKTINFO */
1242 #define	IPV6_RECVHOPLIMIT	0x13	/* enable/disable IPV6_HOPLIMIT */
1243 #define	IPV6_RECVHOPOPTS	0x14	/* enable/disable IPV6_HOPOPTS */
1244 
1245 /*
1246  * This options exists for backwards compatability and should no longer be
1247  * used.  Use IPV6_RECVDSTOPTS instead.
1248  */
1249 #define	_OLD_IPV6_RECVDSTOPTS	0x15
1250 
1251 #define	IPV6_RECVRTHDR		0x16	/* enable/disable IPV6_RTHDR */
1252 
1253 /*
1254  * enable/disable IPV6_RTHDRDSTOPTS.  Now obsolete.  IPV6_RECVDSTOPTS enables
1255  * the receipt of both headers.
1256  */
1257 #define	IPV6_RECVRTHDRDSTOPTS	0x17
1258 
1259 #define	IPV6_CHECKSUM		0x18	/* Control checksum on raw sockets */
1260 #define	IPV6_RECVTCLASS		0x19	/* enable/disable IPV6_TCLASS */
1261 #define	IPV6_USE_MIN_MTU	0x20	/* send packets with minimum MTU */
1262 #define	IPV6_DONTFRAG		0x21	/* don't fragment packets */
1263 #define	IPV6_SEC_OPT		0x22	/* Used to set IPSEC options */
1264 #define	IPV6_SRC_PREFERENCES	0x23	/* Control socket's src addr select */
1265 #define	IPV6_RECVPATHMTU	0x24	/* receive PMTU info */
1266 #define	IPV6_PATHMTU		0x25	/* get the PMTU */
1267 #define	IPV6_TCLASS		0x26	/* traffic class */
1268 #define	IPV6_V6ONLY		0x27	/* v6 only socket option */
1269 
1270 /*
1271  * enable/disable receipt of both both IPV6_DSTOPTS headers.
1272  */
1273 #define	IPV6_RECVDSTOPTS	0x28
1274 
1275 /*
1276  * protocol-independent multicast membership options.
1277  */
1278 #define	MCAST_JOIN_GROUP	0x29	/* join group for all sources */
1279 #define	MCAST_LEAVE_GROUP	0x2a	/* leave group */
1280 #define	MCAST_BLOCK_SOURCE	0x2b	/* block specified source */
1281 #define	MCAST_UNBLOCK_SOURCE	0x2c	/* unblock specified source */
1282 #define	MCAST_JOIN_SOURCE_GROUP	0x2d	/* join group for specified source */
1283 #define	MCAST_LEAVE_SOURCE_GROUP 0x2e	/* leave source/group pair */
1284 
1285 /* 32Bit field for IPV6_SRC_PREFERENCES */
1286 #define	IPV6_PREFER_SRC_HOME		0x00000001
1287 #define	IPV6_PREFER_SRC_COA		0x00000002
1288 #define	IPV6_PREFER_SRC_PUBLIC		0x00000004
1289 #define	IPV6_PREFER_SRC_TMP		0x00000008
1290 #define	IPV6_PREFER_SRC_NONCGA		0x00000010
1291 #define	IPV6_PREFER_SRC_CGA		0x00000020
1292 
1293 #define	IPV6_PREFER_SRC_MIPMASK	(IPV6_PREFER_SRC_HOME | IPV6_PREFER_SRC_COA)
1294 #define	IPV6_PREFER_SRC_MIPDEFAULT	IPV6_PREFER_SRC_HOME
1295 #define	IPV6_PREFER_SRC_TMPMASK	(IPV6_PREFER_SRC_PUBLIC | IPV6_PREFER_SRC_TMP)
1296 #define	IPV6_PREFER_SRC_TMPDEFAULT	IPV6_PREFER_SRC_PUBLIC
1297 #define	IPV6_PREFER_SRC_CGAMASK	(IPV6_PREFER_SRC_NONCGA | IPV6_PREFER_SRC_CGA)
1298 #define	IPV6_PREFER_SRC_CGADEFAULT	IPV6_PREFER_SRC_NONCGA
1299 
1300 #define	IPV6_PREFER_SRC_MASK (IPV6_PREFER_SRC_MIPMASK |\
1301 	IPV6_PREFER_SRC_TMPMASK | IPV6_PREFER_SRC_CGAMASK)
1302 
1303 #define	IPV6_PREFER_SRC_DEFAULT	(IPV6_PREFER_SRC_MIPDEFAULT |\
1304 	IPV6_PREFER_SRC_TMPDEFAULT | IPV6_PREFER_SRC_CGADEFAULT)
1305 
1306 #define	IPV6_MINHOPCOUNT	0x2f	/* minimum acceptable hop limit */
1307 
1308 /*
1309  * SunOS private (potentially not portable) IPV6_ option names
1310  */
1311 #define	IPV6_BOUND_IF		0x41	/* bind to an ifindex */
1312 #define	IPV6_UNSPEC_SRC		0x42	/* source of packets set to */
1313 					/* unspecified (all zeros) */
1314 
1315 /*
1316  * Miscellaneous IPv6 constants.
1317  */
1318 #define	IPV6_PAD1_OPT		0	/* pad byte in IPv6 extension hdrs */
1319 
1320 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
1321 
1322 /*
1323  * Extern declarations for pre-defined global const variables
1324  */
1325 #if !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__)
1326 #ifndef _KERNEL
1327 #ifdef __STDC__
1328 extern const struct in6_addr in6addr_any;
1329 extern const struct in6_addr in6addr_loopback;
1330 #else
1331 extern struct in6_addr in6addr_any;
1332 extern struct in6_addr in6addr_loopback;
1333 #endif
1334 #endif
1335 #endif /* !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__) */
1336 
1337 #ifdef	__cplusplus
1338 }
1339 #endif
1340 
1341 #endif	/* _NETINET_IN_H */
1342