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