Fix glob with empty pattern
[glibc.git] / inet / netinet / in.h
blob180227af5bee479ed42c991eba9e7eb7983624de
1 /* Copyright (C) 1991-2001, 2003, 2004, 2006, 2007, 2008
2 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18 02111-1307 USA. */
20 #ifndef _NETINET_IN_H
21 #define _NETINET_IN_H 1
23 #include <features.h>
24 #include <stdint.h>
25 #include <sys/socket.h>
26 #include <bits/types.h>
29 __BEGIN_DECLS
31 /* Standard well-defined IP protocols. */
32 enum
34 IPPROTO_IP = 0, /* Dummy protocol for TCP. */
35 #define IPPROTO_IP IPPROTO_IP
36 IPPROTO_HOPOPTS = 0, /* IPv6 Hop-by-Hop options. */
37 #define IPPROTO_HOPOPTS IPPROTO_HOPOPTS
38 IPPROTO_ICMP = 1, /* Internet Control Message Protocol. */
39 #define IPPROTO_ICMP IPPROTO_ICMP
40 IPPROTO_IGMP = 2, /* Internet Group Management Protocol. */
41 #define IPPROTO_IGMP IPPROTO_IGMP
42 IPPROTO_IPIP = 4, /* IPIP tunnels (older KA9Q tunnels use 94). */
43 #define IPPROTO_IPIP IPPROTO_IPIP
44 IPPROTO_TCP = 6, /* Transmission Control Protocol. */
45 #define IPPROTO_TCP IPPROTO_TCP
46 IPPROTO_EGP = 8, /* Exterior Gateway Protocol. */
47 #define IPPROTO_EGP IPPROTO_EGP
48 IPPROTO_PUP = 12, /* PUP protocol. */
49 #define IPPROTO_PUP IPPROTO_PUP
50 IPPROTO_UDP = 17, /* User Datagram Protocol. */
51 #define IPPROTO_UDP IPPROTO_UDP
52 IPPROTO_IDP = 22, /* XNS IDP protocol. */
53 #define IPPROTO_IDP IPPROTO_IDP
54 IPPROTO_TP = 29, /* SO Transport Protocol Class 4. */
55 #define IPPROTO_TP IPPROTO_TP
56 IPPROTO_DCCP = 33, /* Datagram Congestion Control Protocol. */
57 #define IPPROTO_DCCP IPPROTO_DCCP
58 IPPROTO_IPV6 = 41, /* IPv6 header. */
59 #define IPPROTO_IPV6 IPPROTO_IPV6
60 IPPROTO_ROUTING = 43, /* IPv6 routing header. */
61 #define IPPROTO_ROUTING IPPROTO_ROUTING
62 IPPROTO_FRAGMENT = 44, /* IPv6 fragmentation header. */
63 #define IPPROTO_FRAGMENT IPPROTO_FRAGMENT
64 IPPROTO_RSVP = 46, /* Reservation Protocol. */
65 #define IPPROTO_RSVP IPPROTO_RSVP
66 IPPROTO_GRE = 47, /* General Routing Encapsulation. */
67 #define IPPROTO_GRE IPPROTO_GRE
68 IPPROTO_ESP = 50, /* encapsulating security payload. */
69 #define IPPROTO_ESP IPPROTO_ESP
70 IPPROTO_AH = 51, /* authentication header. */
71 #define IPPROTO_AH IPPROTO_AH
72 IPPROTO_ICMPV6 = 58, /* ICMPv6. */
73 #define IPPROTO_ICMPV6 IPPROTO_ICMPV6
74 IPPROTO_NONE = 59, /* IPv6 no next header. */
75 #define IPPROTO_NONE IPPROTO_NONE
76 IPPROTO_DSTOPTS = 60, /* IPv6 destination options. */
77 #define IPPROTO_DSTOPTS IPPROTO_DSTOPTS
78 IPPROTO_MTP = 92, /* Multicast Transport Protocol. */
79 #define IPPROTO_MTP IPPROTO_MTP
80 IPPROTO_ENCAP = 98, /* Encapsulation Header. */
81 #define IPPROTO_ENCAP IPPROTO_ENCAP
82 IPPROTO_PIM = 103, /* Protocol Independent Multicast. */
83 #define IPPROTO_PIM IPPROTO_PIM
84 IPPROTO_COMP = 108, /* Compression Header Protocol. */
85 #define IPPROTO_COMP IPPROTO_COMP
86 IPPROTO_SCTP = 132, /* Stream Control Transmission Protocol. */
87 #define IPPROTO_SCTP IPPROTO_SCTP
88 IPPROTO_UDPLITE = 136, /* UDP-Lite protocol. */
89 #define IPPROTO_UDPLITE IPPROTO_UDPLITE
90 IPPROTO_RAW = 255, /* Raw IP packets. */
91 #define IPPROTO_RAW IPPROTO_RAW
92 IPPROTO_MAX
96 /* Type to represent a port. */
97 typedef uint16_t in_port_t;
99 /* Standard well-known ports. */
100 enum
102 IPPORT_ECHO = 7, /* Echo service. */
103 IPPORT_DISCARD = 9, /* Discard transmissions service. */
104 IPPORT_SYSTAT = 11, /* System status service. */
105 IPPORT_DAYTIME = 13, /* Time of day service. */
106 IPPORT_NETSTAT = 15, /* Network status service. */
107 IPPORT_FTP = 21, /* File Transfer Protocol. */
108 IPPORT_TELNET = 23, /* Telnet protocol. */
109 IPPORT_SMTP = 25, /* Simple Mail Transfer Protocol. */
110 IPPORT_TIMESERVER = 37, /* Timeserver service. */
111 IPPORT_NAMESERVER = 42, /* Domain Name Service. */
112 IPPORT_WHOIS = 43, /* Internet Whois service. */
113 IPPORT_MTP = 57,
115 IPPORT_TFTP = 69, /* Trivial File Transfer Protocol. */
116 IPPORT_RJE = 77,
117 IPPORT_FINGER = 79, /* Finger service. */
118 IPPORT_TTYLINK = 87,
119 IPPORT_SUPDUP = 95, /* SUPDUP protocol. */
122 IPPORT_EXECSERVER = 512, /* execd service. */
123 IPPORT_LOGINSERVER = 513, /* rlogind service. */
124 IPPORT_CMDSERVER = 514,
125 IPPORT_EFSSERVER = 520,
127 /* UDP ports. */
128 IPPORT_BIFFUDP = 512,
129 IPPORT_WHOSERVER = 513,
130 IPPORT_ROUTESERVER = 520,
132 /* Ports less than this value are reserved for privileged processes. */
133 IPPORT_RESERVED = 1024,
135 /* Ports greater this value are reserved for (non-privileged) servers. */
136 IPPORT_USERRESERVED = 5000
140 /* Internet address. */
141 typedef uint32_t in_addr_t;
142 struct in_addr
144 in_addr_t s_addr;
148 /* Definitions of the bits in an Internet address integer.
150 On subnets, host and network parts are found according to
151 the subnet mask, not these masks. */
153 #define IN_CLASSA(a) ((((in_addr_t)(a)) & 0x80000000) == 0)
154 #define IN_CLASSA_NET 0xff000000
155 #define IN_CLASSA_NSHIFT 24
156 #define IN_CLASSA_HOST (0xffffffff & ~IN_CLASSA_NET)
157 #define IN_CLASSA_MAX 128
159 #define IN_CLASSB(a) ((((in_addr_t)(a)) & 0xc0000000) == 0x80000000)
160 #define IN_CLASSB_NET 0xffff0000
161 #define IN_CLASSB_NSHIFT 16
162 #define IN_CLASSB_HOST (0xffffffff & ~IN_CLASSB_NET)
163 #define IN_CLASSB_MAX 65536
165 #define IN_CLASSC(a) ((((in_addr_t)(a)) & 0xe0000000) == 0xc0000000)
166 #define IN_CLASSC_NET 0xffffff00
167 #define IN_CLASSC_NSHIFT 8
168 #define IN_CLASSC_HOST (0xffffffff & ~IN_CLASSC_NET)
170 #define IN_CLASSD(a) ((((in_addr_t)(a)) & 0xf0000000) == 0xe0000000)
171 #define IN_MULTICAST(a) IN_CLASSD(a)
173 #define IN_EXPERIMENTAL(a) ((((in_addr_t)(a)) & 0xe0000000) == 0xe0000000)
174 #define IN_BADCLASS(a) ((((in_addr_t)(a)) & 0xf0000000) == 0xf0000000)
176 /* Address to accept any incoming messages. */
177 #define INADDR_ANY ((in_addr_t) 0x00000000)
178 /* Address to send to all hosts. */
179 #define INADDR_BROADCAST ((in_addr_t) 0xffffffff)
180 /* Address indicating an error return. */
181 #define INADDR_NONE ((in_addr_t) 0xffffffff)
183 /* Network number for local host loopback. */
184 #define IN_LOOPBACKNET 127
185 /* Address to loopback in software to local host. */
186 #ifndef INADDR_LOOPBACK
187 # define INADDR_LOOPBACK ((in_addr_t) 0x7f000001) /* Inet 127.0.0.1. */
188 #endif
190 /* Defines for Multicast INADDR. */
191 #define INADDR_UNSPEC_GROUP ((in_addr_t) 0xe0000000) /* 224.0.0.0 */
192 #define INADDR_ALLHOSTS_GROUP ((in_addr_t) 0xe0000001) /* 224.0.0.1 */
193 #define INADDR_ALLRTRS_GROUP ((in_addr_t) 0xe0000002) /* 224.0.0.2 */
194 #define INADDR_MAX_LOCAL_GROUP ((in_addr_t) 0xe00000ff) /* 224.0.0.255 */
197 /* IPv6 address */
198 struct in6_addr
200 union
202 uint8_t __u6_addr8[16];
203 #if defined __USE_MISC || defined __USE_GNU
204 uint16_t __u6_addr16[8];
205 uint32_t __u6_addr32[4];
206 #endif
207 } __in6_u;
208 #define s6_addr __in6_u.__u6_addr8
209 #if defined __USE_MISC || defined __USE_GNU
210 # define s6_addr16 __in6_u.__u6_addr16
211 # define s6_addr32 __in6_u.__u6_addr32
212 #endif
215 extern const struct in6_addr in6addr_any; /* :: */
216 extern const struct in6_addr in6addr_loopback; /* ::1 */
217 #define IN6ADDR_ANY_INIT { { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 } } }
218 #define IN6ADDR_LOOPBACK_INIT { { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1 } } }
220 #define INET_ADDRSTRLEN 16
221 #define INET6_ADDRSTRLEN 46
224 /* Structure describing an Internet socket address. */
225 struct sockaddr_in
227 __SOCKADDR_COMMON (sin_);
228 in_port_t sin_port; /* Port number. */
229 struct in_addr sin_addr; /* Internet address. */
231 /* Pad to size of `struct sockaddr'. */
232 unsigned char sin_zero[sizeof (struct sockaddr) -
233 __SOCKADDR_COMMON_SIZE -
234 sizeof (in_port_t) -
235 sizeof (struct in_addr)];
238 /* Ditto, for IPv6. */
239 struct sockaddr_in6
241 __SOCKADDR_COMMON (sin6_);
242 in_port_t sin6_port; /* Transport layer port # */
243 uint32_t sin6_flowinfo; /* IPv6 flow information */
244 struct in6_addr sin6_addr; /* IPv6 address */
245 uint32_t sin6_scope_id; /* IPv6 scope-id */
249 #if defined __USE_MISC || defined __USE_GNU
250 /* IPv4 multicast request. */
251 struct ip_mreq
253 /* IP multicast address of group. */
254 struct in_addr imr_multiaddr;
256 /* Local IP address of interface. */
257 struct in_addr imr_interface;
260 struct ip_mreq_source
262 /* IP multicast address of group. */
263 struct in_addr imr_multiaddr;
265 /* IP address of source. */
266 struct in_addr imr_interface;
268 /* IP address of interface. */
269 struct in_addr imr_sourceaddr;
271 #endif
274 /* Likewise, for IPv6. */
275 struct ipv6_mreq
277 /* IPv6 multicast address of group */
278 struct in6_addr ipv6mr_multiaddr;
280 /* local interface */
281 unsigned int ipv6mr_interface;
285 #if defined __USE_MISC || defined __USE_GNU
286 /* Multicast group request. */
287 struct group_req
289 /* Interface index. */
290 uint32_t gr_interface;
292 /* Group address. */
293 struct sockaddr_storage gr_group;
296 struct group_source_req
298 /* Interface index. */
299 uint32_t gsr_interface;
301 /* Group address. */
302 struct sockaddr_storage gsr_group;
304 /* Source address. */
305 struct sockaddr_storage gsr_source;
309 /* Full-state filter operations. */
310 struct ip_msfilter
312 /* IP multicast address of group. */
313 struct in_addr imsf_multiaddr;
315 /* Local IP address of interface. */
316 struct in_addr imsf_interface;
318 /* Filter mode. */
319 uint32_t imsf_fmode;
321 /* Number of source addresses. */
322 uint32_t imsf_numsrc;
323 /* Source addresses. */
324 struct in_addr imsf_slist[1];
327 #define IP_MSFILTER_SIZE(numsrc) (sizeof (struct ip_msfilter) \
328 - sizeof (struct in_addr) \
329 + (numsrc) * sizeof (struct in_addr))
331 struct group_filter
333 /* Interface index. */
334 uint32_t gf_interface;
336 /* Group address. */
337 struct sockaddr_storage gf_group;
339 /* Filter mode. */
340 uint32_t gf_fmode;
342 /* Number of source addresses. */
343 uint32_t gf_numsrc;
344 /* Source addresses. */
345 struct sockaddr_storage gf_slist[1];
348 #define GROUP_FILTER_SIZE(numsrc) (sizeof (struct group_filter) \
349 - sizeof (struct sockaddr_storage) \
350 + ((numsrc) \
351 * sizeof (struct sockaddr_storage)))
352 #endif
355 /* Get system-specific definitions. */
356 #include <bits/in.h>
358 /* Functions to convert between host and network byte order.
360 Please note that these functions normally take `unsigned long int' or
361 `unsigned short int' values as arguments and also return them. But
362 this was a short-sighted decision since on different systems the types
363 may have different representations but the values are always the same. */
365 extern uint32_t ntohl (uint32_t __netlong) __THROW __attribute__ ((__const__));
366 extern uint16_t ntohs (uint16_t __netshort)
367 __THROW __attribute__ ((__const__));
368 extern uint32_t htonl (uint32_t __hostlong)
369 __THROW __attribute__ ((__const__));
370 extern uint16_t htons (uint16_t __hostshort)
371 __THROW __attribute__ ((__const__));
373 #include <endian.h>
375 /* Get machine dependent optimized versions of byte swapping functions. */
376 #include <bits/byteswap.h>
378 #ifdef __OPTIMIZE__
379 /* We can optimize calls to the conversion functions. Either nothing has
380 to be done or we are using directly the byte-swapping functions which
381 often can be inlined. */
382 # if __BYTE_ORDER == __BIG_ENDIAN
383 /* The host byte order is the same as network byte order,
384 so these functions are all just identity. */
385 # define ntohl(x) (x)
386 # define ntohs(x) (x)
387 # define htonl(x) (x)
388 # define htons(x) (x)
389 # else
390 # if __BYTE_ORDER == __LITTLE_ENDIAN
391 # define ntohl(x) __bswap_32 (x)
392 # define ntohs(x) __bswap_16 (x)
393 # define htonl(x) __bswap_32 (x)
394 # define htons(x) __bswap_16 (x)
395 # endif
396 # endif
397 #endif
399 #define IN6_IS_ADDR_UNSPECIFIED(a) \
400 (((__const uint32_t *) (a))[0] == 0 \
401 && ((__const uint32_t *) (a))[1] == 0 \
402 && ((__const uint32_t *) (a))[2] == 0 \
403 && ((__const uint32_t *) (a))[3] == 0)
405 #define IN6_IS_ADDR_LOOPBACK(a) \
406 (((__const uint32_t *) (a))[0] == 0 \
407 && ((__const uint32_t *) (a))[1] == 0 \
408 && ((__const uint32_t *) (a))[2] == 0 \
409 && ((__const uint32_t *) (a))[3] == htonl (1))
411 #define IN6_IS_ADDR_MULTICAST(a) (((__const uint8_t *) (a))[0] == 0xff)
413 #define IN6_IS_ADDR_LINKLOCAL(a) \
414 ((((__const uint32_t *) (a))[0] & htonl (0xffc00000)) \
415 == htonl (0xfe800000))
417 #define IN6_IS_ADDR_SITELOCAL(a) \
418 ((((__const uint32_t *) (a))[0] & htonl (0xffc00000)) \
419 == htonl (0xfec00000))
421 #define IN6_IS_ADDR_V4MAPPED(a) \
422 ((((__const uint32_t *) (a))[0] == 0) \
423 && (((__const uint32_t *) (a))[1] == 0) \
424 && (((__const uint32_t *) (a))[2] == htonl (0xffff)))
426 #define IN6_IS_ADDR_V4COMPAT(a) \
427 ((((__const uint32_t *) (a))[0] == 0) \
428 && (((__const uint32_t *) (a))[1] == 0) \
429 && (((__const uint32_t *) (a))[2] == 0) \
430 && (ntohl (((__const uint32_t *) (a))[3]) > 1))
432 #define IN6_ARE_ADDR_EQUAL(a,b) \
433 ((((__const uint32_t *) (a))[0] == ((__const uint32_t *) (b))[0]) \
434 && (((__const uint32_t *) (a))[1] == ((__const uint32_t *) (b))[1]) \
435 && (((__const uint32_t *) (a))[2] == ((__const uint32_t *) (b))[2]) \
436 && (((__const uint32_t *) (a))[3] == ((__const uint32_t *) (b))[3]))
438 #if defined __USE_MISC || defined __USE_GNU
439 /* Bind socket to a privileged IP port. */
440 extern int bindresvport (int __sockfd, struct sockaddr_in *__sock_in) __THROW;
442 /* The IPv6 version of this function. */
443 extern int bindresvport6 (int __sockfd, struct sockaddr_in6 *__sock_in)
444 __THROW;
445 #endif
448 #define IN6_IS_ADDR_MC_NODELOCAL(a) \
449 (IN6_IS_ADDR_MULTICAST(a) \
450 && ((((__const uint8_t *) (a))[1] & 0xf) == 0x1))
452 #define IN6_IS_ADDR_MC_LINKLOCAL(a) \
453 (IN6_IS_ADDR_MULTICAST(a) \
454 && ((((__const uint8_t *) (a))[1] & 0xf) == 0x2))
456 #define IN6_IS_ADDR_MC_SITELOCAL(a) \
457 (IN6_IS_ADDR_MULTICAST(a) \
458 && ((((__const uint8_t *) (a))[1] & 0xf) == 0x5))
460 #define IN6_IS_ADDR_MC_ORGLOCAL(a) \
461 (IN6_IS_ADDR_MULTICAST(a) \
462 && ((((__const uint8_t *) (a))[1] & 0xf) == 0x8))
464 #define IN6_IS_ADDR_MC_GLOBAL(a) \
465 (IN6_IS_ADDR_MULTICAST(a) \
466 && ((((__const uint8_t *) (a))[1] & 0xf) == 0xe))
469 #ifdef __USE_GNU
470 /* IPv6 packet information. */
471 struct in6_pktinfo
473 struct in6_addr ipi6_addr; /* src/dst IPv6 address */
474 unsigned int ipi6_ifindex; /* send/recv interface index */
477 /* IPv6 MTU information. */
478 struct ip6_mtuinfo
480 struct sockaddr_in6 ip6m_addr; /* dst address including zone ID */
481 uint32_t ip6m_mtu; /* path MTU in host byte order */
485 /* Obsolete hop-by-hop and Destination Options Processing (RFC 2292). */
486 extern int inet6_option_space (int __nbytes)
487 __THROW __attribute_deprecated__;
488 extern int inet6_option_init (void *__bp, struct cmsghdr **__cmsgp,
489 int __type) __THROW __attribute_deprecated__;
490 extern int inet6_option_append (struct cmsghdr *__cmsg,
491 __const uint8_t *__typep, int __multx,
492 int __plusy) __THROW __attribute_deprecated__;
493 extern uint8_t *inet6_option_alloc (struct cmsghdr *__cmsg, int __datalen,
494 int __multx, int __plusy)
495 __THROW __attribute_deprecated__;
496 extern int inet6_option_next (__const struct cmsghdr *__cmsg,
497 uint8_t **__tptrp)
498 __THROW __attribute_deprecated__;
499 extern int inet6_option_find (__const struct cmsghdr *__cmsg,
500 uint8_t **__tptrp, int __type)
501 __THROW __attribute_deprecated__;
504 /* Hop-by-Hop and Destination Options Processing (RFC 3542). */
505 extern int inet6_opt_init (void *__extbuf, socklen_t __extlen) __THROW;
506 extern int inet6_opt_append (void *__extbuf, socklen_t __extlen, int __offset,
507 uint8_t __type, socklen_t __len, uint8_t __align,
508 void **__databufp) __THROW;
509 extern int inet6_opt_finish (void *__extbuf, socklen_t __extlen, int __offset)
510 __THROW;
511 extern int inet6_opt_set_val (void *__databuf, int __offset, void *__val,
512 socklen_t __vallen) __THROW;
513 extern int inet6_opt_next (void *__extbuf, socklen_t __extlen, int __offset,
514 uint8_t *__typep, socklen_t *__lenp,
515 void **__databufp) __THROW;
516 extern int inet6_opt_find (void *__extbuf, socklen_t __extlen, int __offset,
517 uint8_t __type, socklen_t *__lenp,
518 void **__databufp) __THROW;
519 extern int inet6_opt_get_val (void *__databuf, int __offset, void *__val,
520 socklen_t __vallen) __THROW;
523 /* Routing Header Option (RFC 3542). */
524 extern socklen_t inet6_rth_space (int __type, int __segments) __THROW;
525 extern void *inet6_rth_init (void *__bp, socklen_t __bp_len, int __type,
526 int __segments) __THROW;
527 extern int inet6_rth_add (void *__bp, __const struct in6_addr *__addr) __THROW;
528 extern int inet6_rth_reverse (__const void *__in, void *__out) __THROW;
529 extern int inet6_rth_segments (__const void *__bp) __THROW;
530 extern struct in6_addr *inet6_rth_getaddr (__const void *__bp, int __index)
531 __THROW;
534 /* Multicast source filter support. */
536 /* Get IPv4 source filter. */
537 extern int getipv4sourcefilter (int __s, struct in_addr __interface_addr,
538 struct in_addr __group, uint32_t *__fmode,
539 uint32_t *__numsrc, struct in_addr *__slist)
540 __THROW;
542 /* Set IPv4 source filter. */
543 extern int setipv4sourcefilter (int __s, struct in_addr __interface_addr,
544 struct in_addr __group, uint32_t __fmode,
545 uint32_t __numsrc,
546 __const struct in_addr *__slist)
547 __THROW;
550 /* Get source filter. */
551 extern int getsourcefilter (int __s, uint32_t __interface_addr,
552 __const struct sockaddr *__group,
553 socklen_t __grouplen, uint32_t *__fmode,
554 uint32_t *__numsrc,
555 struct sockaddr_storage *__slist) __THROW;
557 /* Set source filter. */
558 extern int setsourcefilter (int __s, uint32_t __interface_addr,
559 __const struct sockaddr *__group,
560 socklen_t __grouplen, uint32_t __fmode,
561 uint32_t __numsrc,
562 __const struct sockaddr_storage *__slist) __THROW;
563 #endif /* use GNU */
565 __END_DECLS
567 #endif /* netinet/in.h */