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