(IN_CLASSC): Correct mask.
[kopensolaris-gnu/glibc.git] / inet / netinet / in.h
1 /* Copyright (C) 1991,92,93,94,95,96,97,98 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Library General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Library General Public License for more details.
13
14    You should have received a copy of the GNU Library General Public
15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17    Boston, MA 02111-1307, USA.  */
18
19 #ifndef _NETINET_IN_H
20 #define _NETINET_IN_H   1
21
22 #include <features.h>
23 #include <stdint.h>
24
25 #include <sys/types.h>
26 #include <bits/socket.h>
27
28
29 __BEGIN_DECLS
30
31 /* Standard well-defined IP protocols.  */
32 enum
33   {
34     IPPROTO_IP = 0,        /* Dummy protocol for TCP.  */
35     IPPROTO_HOPOPTS = 0,   /* IPv6 Hop-by-Hop options.  */
36     IPPROTO_ICMP = 1,      /* Internet Control Message Protocol.  */
37     IPPROTO_IGMP = 2,      /* Internet Group Management Protocol. */
38     IPPROTO_IPIP = 4,      /* IPIP tunnels (older KA9Q tunnels use 94).  */
39     IPPROTO_TCP = 6,       /* Transmission Control Protocol.  */
40     IPPROTO_EGP = 8,       /* Exterior Gateway Protocol.  */
41     IPPROTO_PUP = 12,      /* PUP protocol.  */
42     IPPROTO_UDP = 17,      /* User Datagram Protocol.  */
43     IPPROTO_IDP = 22,      /* XNS IDP protocol.  */
44     IPPROTO_IPV6 = 41,     /* IPv6 header.  */
45     IPPROTO_ROUTING = 43,  /* IPv6 routing header.  */
46     IPPROTO_FRAGMENT = 44, /* IPv6 fragmentation header.  */
47     IPPROTO_ESP = 50,      /* encapsulating security payload.  */
48     IPPROTO_AH = 51,       /* authentication header.  */
49     IPPROTO_ICMPV6 = 58,   /* ICMPv6.  */
50     IPPROTO_NONE = 59,     /* IPv6 no next header.  */
51     IPPROTO_DSTOPTS = 60,  /* IPv6 destination options.  */
52     IPPROTO_RAW = 255,     /* Raw IP packets.  */
53     IPPROTO_MAX
54   };
55
56 /* Standard well-known ports.  */
57 enum
58   {
59     IPPORT_ECHO = 7,            /* Echo service.  */
60     IPPORT_DISCARD = 9,         /* Discard transmissions service.  */
61     IPPORT_SYSTAT = 11,         /* System status service.  */
62     IPPORT_DAYTIME = 13,        /* Time of day service.  */
63     IPPORT_NETSTAT = 15,        /* Network status service.  */
64     IPPORT_FTP = 21,            /* File Transfer Protocol.  */
65     IPPORT_TELNET = 23,         /* Telnet protocol.  */
66     IPPORT_SMTP = 25,           /* Simple Mail Transfer Protocol.  */
67     IPPORT_TIMESERVER = 37,     /* Timeserver service.  */
68     IPPORT_NAMESERVER = 42,     /* Domain Name Service.  */
69     IPPORT_WHOIS = 43,          /* Internet Whois service.  */
70     IPPORT_MTP = 57,
71
72     IPPORT_TFTP = 69,           /* Trivial File Transfer Protocol.  */
73     IPPORT_RJE = 77,
74     IPPORT_FINGER = 79,         /* Finger service.  */
75     IPPORT_TTYLINK = 87,
76     IPPORT_SUPDUP = 95,         /* SUPDUP protocol.  */
77
78
79     IPPORT_EXECSERVER = 512,    /* execd service.  */
80     IPPORT_LOGINSERVER = 513,   /* rlogind service.  */
81     IPPORT_CMDSERVER = 514,
82     IPPORT_EFSSERVER = 520,
83
84     /* UDP ports.  */
85     IPPORT_BIFFUDP = 512,
86     IPPORT_WHOSERVER = 513,
87     IPPORT_ROUTESERVER = 520,
88
89     /* Ports less than this value are reserved for privileged processes.  */
90     IPPORT_RESERVED = 1024,
91
92     /* Ports greater this value are reserved for (non-privileged) servers.  */
93     IPPORT_USERRESERVED = 5000
94   };
95
96
97 /* Internet address.  */
98 struct in_addr
99   {
100     uint32_t s_addr;
101   };
102
103
104 /* Definitions of the bits in an Internet address integer.
105
106    On subnets, host and network parts are found according to
107    the subnet mask, not these masks.  */
108
109 #define IN_CLASSA(a)            ((((uint32_t) (a)) & 0x80000000) == 0)
110 #define IN_CLASSA_NET           0xff000000
111 #define IN_CLASSA_NSHIFT        24
112 #define IN_CLASSA_HOST          (0xffffffff & ~IN_CLASSA_NET)
113 #define IN_CLASSA_MAX           128
114
115 #define IN_CLASSB(a)            ((((uint32_t) (a)) & 0xc0000000) == 0x80000000)
116 #define IN_CLASSB_NET           0xffff0000
117 #define IN_CLASSB_NSHIFT        16
118 #define IN_CLASSB_HOST          (0xffffffff & ~IN_CLASSB_NET)
119 #define IN_CLASSB_MAX           65536
120
121 #define IN_CLASSC(a)            ((((uint32_t) (a)) & 0xe0000000) == 0xc0000000)
122 #define IN_CLASSC_NET           0xffffff00
123 #define IN_CLASSC_NSHIFT        8
124 #define IN_CLASSC_HOST          (0xffffffff & ~IN_CLASSC_NET)
125
126 #define IN_CLASSD(a)            ((((uint32_t) (a)) & 0xf0000000) == 0xe0000000)
127 #define IN_MULTICAST(a)         IN_CLASSD(a)
128
129 #define IN_EXPERIMENTAL(a)      ((((uint32_t) (a)) & 0xe0000000) == 0xe0000000)
130 #define IN_BADCLASS(a)          ((((uint32_t) (a)) & 0xf0000000) == 0xf0000000)
131
132 /* Address to accept any incoming messages.  */
133 #define INADDR_ANY              ((uint32_t) 0x00000000)
134 /* Address to send to all hosts.  */
135 #define INADDR_BROADCAST        ((uint32_t) 0xffffffff)
136 /* Address indicating an error return.  */
137 #define INADDR_NONE             ((uint32_t) 0xffffffff)
138
139 /* Network number for local host loopback.  */
140 #define IN_LOOPBACKNET          127
141 /* Address to loopback in software to local host.  */
142 #ifndef INADDR_LOOPBACK
143 # define INADDR_LOOPBACK        ((uint32_t) 0x7f000001) /* Inet 127.0.0.1.  */
144 #endif
145
146 /* Defines for Multicast INADDR.  */
147 #define INADDR_UNSPEC_GROUP     ((uint32_t) 0xe0000000)      /* 224.0.0.0 */
148 #define INADDR_ALLHOSTS_GROUP   ((uint32_t) 0xe0000001)      /* 224.0.0.1 */
149 #define INADDR_ALLRTRS_GROUP    ((uint32_t) 0xe0000002)      /* 224.0.0.2 */
150 #define INADDR_MAX_LOCAL_GROUP  ((uint32_t) 0xe00000ff)      /* 224.0.0.255 */
151
152
153 /* IPv6 address */
154 struct in6_addr
155   {
156     union
157       {
158         uint8_t         u6_addr8[16];
159         uint16_t        u6_addr16[8];
160         uint32_t        u6_addr32[4];
161 #if (~0UL) > 0xffffffff
162         uint64_t        u6_addr64[2];
163 #endif
164       } in6_u;
165 #define s6_addr                 in6_u.u6_addr8
166 #define s6_addr16               in6_u.u6_addr16
167 #define s6_addr32               in6_u.u6_addr32
168 #define s6_addr64               in6_u.u6_addr64
169   };
170
171 extern const struct in6_addr in6addr_any;        /* :: */
172 extern const struct in6_addr in6addr_loopback;   /* ::1 */
173 #define IN6ADDR_ANY_INIT { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 }
174 #define IN6ADDR_LOOPBACK_INIT { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1 }
175
176 #define INET_ADDRSTRLEN 16
177 #define INET6_ADDRSTRLEN 46
178
179 /* Get the definition of the macro to define the common sockaddr members.  */
180 #include <bits/sockaddr.h>
181
182
183 /* Structure describing an Internet socket address.  */
184 struct sockaddr_in
185   {
186     __SOCKADDR_COMMON (sin_);
187     uint16_t sin_port;                  /* Port number.  */
188     struct in_addr sin_addr;            /* Internet address.  */
189
190     /* Pad to size of `struct sockaddr'.  */
191     unsigned char sin_zero[sizeof (struct sockaddr) -
192                            __SOCKADDR_COMMON_SIZE -
193                            sizeof (uint16_t) -
194                            sizeof (struct in_addr)];
195   };
196
197 /* Ditto, for IPv6.  */
198 struct sockaddr_in6
199   {
200     __SOCKADDR_COMMON (sin6_);
201     uint16_t sin6_port;         /* Transport layer port # */
202     uint32_t sin6_flowinfo;     /* IPv6 flow information */
203     struct in6_addr sin6_addr;  /* IPv6 address */
204   };
205
206 /* IPv6 multicast request.  */
207 struct ipv6_mreq
208   {
209     /* IPv6 multicast address of group */
210     struct in6_addr ipv6mr_multiaddr;
211
212     /* local interface */
213     unsigned int ipv6mr_ifindex;
214   };
215
216 /* Get system-specific definitions.  */
217 #include <bits/in.h>
218
219 /* Functions to convert between host and network byte order.
220
221    Please note that these functions normally take `unsigned long int' or
222    `unsigned short int' values as arguments and also return them.  But
223    this was a short-sighted decision since on different systems the types
224    may have different representations but the values are always the same.  */
225
226 extern uint32_t ntohl __P ((uint32_t __netlong));
227 extern uint16_t ntohs __P ((uint16_t __netshort));
228 extern uint32_t htonl __P ((uint32_t __hostlong));
229 extern uint16_t htons __P ((uint16_t __hostshort));
230
231 #include <endian.h>
232
233 /* Get machine dependent optimized versions of byte swapping functions.  */
234 #include <bits/byteswap.h>
235
236 #if __BYTE_ORDER == __BIG_ENDIAN && defined __OPTIMIZE__
237 /* The host byte order is the same as network byte order,
238    so these functions are all just identity.  */
239 # define ntohl(x)       (x)
240 # define ntohs(x)       (x)
241 # define htonl(x)       (x)
242 # define htons(x)       (x)
243 #else
244 # if __BYTE_ORDER == __LITTLE_ENDIAN && defined __OPTIMIZE__
245 #  define ntohl(x)      __bswap_32 (x)
246 #  define ntohs(x)      __bswap_16 (x)
247 #  define htonl(x)      __bswap_32 (x)
248 #  define htons(x)      __bswap_16 (x)
249 # endif
250 #endif
251
252 #define IN6_IS_ADDR_UNSPECIFIED(a) \
253         (((uint32_t *) (a))[0] == 0 && ((uint32_t *) (a))[1] == 0 && \
254          ((uint32_t *) (a))[2] == 0 && ((uint32_t *) (a))[3] == 0)
255
256 #define IN6_IS_ADDR_LOOPBACK(a) \
257         (((uint32_t *) (a))[0] == 0 && ((uint32_t *) (a))[1] == 0 && \
258          ((uint32_t *) (a))[2] == 0 && ((uint32_t *) (a))[3] == htonl (1))
259
260 #define IN6_IS_ADDR_MULTICAST(a) (((u_int8_t *) (a))[0] == 0xff)
261
262 #define IN6_IS_ADDR_LINKLOCAL(a) \
263         ((((uint32_t *) (a))[0] & htonl (0xffc00000)) == htonl (0xfe800000))
264
265 #define IN6_IS_ADDR_SITELOCAL(a) \
266         ((((uint32_t *) (a))[0] & htonl (0xffc00000)) == htonl (0xfec00000))
267
268 #define IN6_IS_ADDR_V4MAPPED(a) \
269         ((((uint32_t *) (a))[0] == 0) && (((uint32_t *) (a))[1] == 0) && \
270          (((uint32_t *) (a))[2] == htonl (0xffff)))
271
272 #define IN6_IS_ADDR_V4COMPAT(a) \
273         ((((uint32_t *) (a))[0] == 0) && (((uint32_t *) (a))[1] == 0) && \
274          (((uint32_t *) (a))[2] == 0) && (ntohl (((uint32_t *) (a))[3]) > 1))
275
276 #define IN6_ARE_ADDR_EQUAL(a,b) \
277         ((((uint32_t *) (a))[0] == ((uint32_t *) (b))[0]) && \
278          (((uint32_t *) (a))[1] == ((uint32_t *) (b))[2]) && \
279          (((uint32_t *) (a))[2] == ((uint32_t *) (b))[1]) && \
280          (((uint32_t *) (a))[3] == ((uint32_t *) (b))[3]))
281
282 /* Bind socket to a privileged IP port.  */
283 extern int bindresvport __P ((int __sockfd, struct sockaddr_in *__sock_in));
284
285
286
287 #define IN6_IS_ADDR_MC_NODELOCAL(a) \
288         (IN6_IS_ADDR_MULTICAST(a) && ((((u_int8_t *) (a))[1] & 0xf) == 0x1))
289
290 #define IN6_IS_ADDR_MC_LINKLOCAL(a) \
291         (IN6_IS_ADDR_MULTICAST(a) && ((((u_int8_t *) (a))[1] & 0xf) == 0x2))
292
293 #define IN6_IS_ADDR_MC_SITELOCAL(a) \
294         (IN6_IS_ADDR_MULTICAST(a) && ((((u_int8_t *) (a))[1] & 0xf) == 0x5))
295
296 #define IN6_IS_ADDR_MC_ORGLOCAL(a) \
297         (IN6_IS_ADDR_MULTICAST(a) && ((((u_int8_t *) (a))[1] & 0xf) == 0x8))
298
299 #define IN6_IS_ADDR_MC_GLOBAL(a) \
300         (IN6_IS_ADDR_MULTICAST(a) && ((((u_int8_t *) (a))[1] & 0xf) == 0xe))
301
302 /* IPv6 packet information.  */
303 struct in6_pktinfo
304   {
305     struct in6_addr     ipi6_addr;    /* src/dst IPv6 address */
306     unsigned int        ipi6_ifindex; /* send/recv interface index */
307   };
308
309 __END_DECLS
310
311 #endif  /* netinet/in.h */