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