in.h revision 1.60 1 /* $NetBSD: in.h,v 1.60 2003/04/12 00:17:49 dogcow Exp $ */
2
3 /*
4 * Copyright (c) 1982, 1986, 1990, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by the University of
18 * California, Berkeley and its contributors.
19 * 4. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 * @(#)in.h 8.3 (Berkeley) 1/3/94
36 */
37
38 /*
39 * Constants and structures defined by the internet system,
40 * Per RFC 790, September 1981, and numerous additions.
41 */
42
43 #ifndef _NETINET_IN_H_
44 #define _NETINET_IN_H_
45
46 #include <machine/int_types.h>
47
48 #ifndef uint8_t
49 typedef __uint8_t uint8_t;
50 #define uint8_t __uint8_t
51 #endif
52
53 #ifndef uint32_t
54 typedef __uint32_t uint32_t;
55 #define uint32_t __uint32_t
56 #endif
57
58 #include <sys/ansi.h>
59
60 #ifndef in_addr_t
61 typedef __in_addr_t in_addr_t;
62 #define in_addr_t __in_addr_t
63 #endif
64
65 #ifndef in_port_t
66 typedef __in_port_t in_port_t;
67 #define in_port_t __in_port_t
68 #endif
69
70 #ifndef sa_family_t
71 typedef __sa_family_t sa_family_t;
72 #define sa_family_t __sa_family_t
73 #endif
74
75 /*
76 * Protocols
77 */
78 #define IPPROTO_IP 0 /* dummy for IP */
79 #define IPPROTO_HOPOPTS 0 /* IP6 hop-by-hop options */
80 #define IPPROTO_ICMP 1 /* control message protocol */
81 #define IPPROTO_IGMP 2 /* group mgmt protocol */
82 #define IPPROTO_GGP 3 /* gateway^2 (deprecated) */
83 #define IPPROTO_IPV4 4 /* IP header */
84 #define IPPROTO_IPIP 4 /* IP inside IP */
85 #define IPPROTO_TCP 6 /* tcp */
86 #define IPPROTO_EGP 8 /* exterior gateway protocol */
87 #define IPPROTO_PUP 12 /* pup */
88 #define IPPROTO_UDP 17 /* user datagram protocol */
89 #define IPPROTO_IDP 22 /* xns idp */
90 #define IPPROTO_TP 29 /* tp-4 w/ class negotiation */
91 #define IPPROTO_IPV6 41 /* IP6 header */
92 #define IPPROTO_ROUTING 43 /* IP6 routing header */
93 #define IPPROTO_FRAGMENT 44 /* IP6 fragmentation header */
94 #define IPPROTO_RSVP 46 /* resource reservation */
95 #define IPPROTO_GRE 47 /* GRE encaps RFC 1701 */
96 #define IPPROTO_ESP 50 /* encap. security payload */
97 #define IPPROTO_AH 51 /* authentication header */
98 #define IPPROTO_MOBILE 55 /* IP Mobility RFC 2004 */
99 #define IPPROTO_IPV6_ICMP 58 /* IPv6 ICMP */
100 #define IPPROTO_ICMPV6 58 /* ICMP6 */
101 #define IPPROTO_NONE 59 /* IP6 no next header */
102 #define IPPROTO_DSTOPTS 60 /* IP6 destination option */
103 #define IPPROTO_EON 80 /* ISO cnlp */
104 #define IPPROTO_ENCAP 98 /* encapsulation header */
105 #define IPPROTO_PIM 103 /* Protocol indep. multicast */
106 #define IPPROTO_IPCOMP 108 /* IP Payload Comp. Protocol */
107 #define IPPROTO_VRRP 112 /* VRRP RFC 2338 */
108
109 #define IPPROTO_RAW 255 /* raw IP packet */
110 #define IPPROTO_MAX 256
111
112 /* last return value of *_input(), meaning "all job for this pkt is done". */
113 #define IPPROTO_DONE 257
114
115
116 /*
117 * Local port number conventions:
118 *
119 * Ports < IPPORT_RESERVED are reserved for privileged processes (e.g. root),
120 * unless a kernel is compiled with IPNOPRIVPORTS defined.
121 *
122 * When a user does a bind(2) or connect(2) with a port number of zero,
123 * a non-conflicting local port address is chosen.
124 *
125 * The default range is IPPORT_ANONMIN to IPPORT_ANONMAX, although
126 * that is settable by sysctl(3); net.inet.ip.anonportmin and
127 * net.inet.ip.anonportmax respectively.
128 *
129 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
130 * default assignment range.
131 *
132 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
133 *
134 * The value IP_PORTRANGE_HIGH is the same as IP_PORTRANGE_DEFAULT,
135 * and exists only for FreeBSD compatibility purposes.
136 *
137 * The value IP_PORTRANGE_LOW changes the range to the "low" are
138 * that is (by convention) restricted to privileged processes.
139 * This convention is based on "vouchsafe" principles only.
140 * It is only secure if you trust the remote host to restrict these ports.
141 * The range is IPPORT_RESERVEDMIN to IPPORT_RESERVEDMAX.
142 */
143
144 #define IPPORT_RESERVED 1024
145 #define IPPORT_ANONMIN 49152
146 #define IPPORT_ANONMAX 65535
147 #define IPPORT_RESERVEDMIN 600
148 #define IPPORT_RESERVEDMAX (IPPORT_RESERVED-1)
149
150 /*
151 * Internet address (a structure for historical reasons)
152 */
153 struct in_addr {
154 in_addr_t s_addr;
155 } __attribute__((__packed__));
156
157 /*
158 * Definitions of bits in internet address integers.
159 * On subnets, the decomposition of addresses to host and net parts
160 * is done according to subnet mask, not the masks here.
161 *
162 * By byte-swapping the constants, we avoid ever having to byte-swap IP
163 * addresses inside the kernel. Unfortunately, user-level programs rely
164 * on these macros not doing byte-swapping.
165 */
166 #ifdef _KERNEL
167 #define __IPADDR(x) ((uint32_t) htonl((uint32_t)(x)))
168 #else
169 #define __IPADDR(x) ((uint32_t)(x))
170 #endif
171
172 #define IN_CLASSA(i) (((uint32_t)(i) & __IPADDR(0x80000000)) == \
173 __IPADDR(0x00000000))
174 #define IN_CLASSA_NET __IPADDR(0xff000000)
175 #define IN_CLASSA_NSHIFT 24
176 #define IN_CLASSA_HOST __IPADDR(0x00ffffff)
177 #define IN_CLASSA_MAX 128
178
179 #define IN_CLASSB(i) (((uint32_t)(i) & __IPADDR(0xc0000000)) == \
180 __IPADDR(0x80000000))
181 #define IN_CLASSB_NET __IPADDR(0xffff0000)
182 #define IN_CLASSB_NSHIFT 16
183 #define IN_CLASSB_HOST __IPADDR(0x0000ffff)
184 #define IN_CLASSB_MAX 65536
185
186 #define IN_CLASSC(i) (((uint32_t)(i) & __IPADDR(0xe0000000)) == \
187 __IPADDR(0xc0000000))
188 #define IN_CLASSC_NET __IPADDR(0xffffff00)
189 #define IN_CLASSC_NSHIFT 8
190 #define IN_CLASSC_HOST __IPADDR(0x000000ff)
191
192 #define IN_CLASSD(i) (((uint32_t)(i) & __IPADDR(0xf0000000)) == \
193 __IPADDR(0xe0000000))
194 /* These ones aren't really net and host fields, but routing needn't know. */
195 #define IN_CLASSD_NET __IPADDR(0xf0000000)
196 #define IN_CLASSD_NSHIFT 28
197 #define IN_CLASSD_HOST __IPADDR(0x0fffffff)
198 #define IN_MULTICAST(i) IN_CLASSD(i)
199
200 #define IN_EXPERIMENTAL(i) (((uint32_t)(i) & __IPADDR(0xf0000000)) == \
201 __IPADDR(0xf0000000))
202 #define IN_BADCLASS(i) (((uint32_t)(i) & __IPADDR(0xf0000000)) == \
203 __IPADDR(0xf0000000))
204
205 #define IN_LOCAL_GROUP(i) (((uint32_t)(i) & __IPADDR(0xffffff00)) == \
206 __IPADDR(0xe0000000))
207
208 #define INADDR_ANY __IPADDR(0x00000000)
209 #define INADDR_LOOPBACK __IPADDR(0x7f000001)
210 #define INADDR_BROADCAST __IPADDR(0xffffffff) /* must be masked */
211 #ifndef _KERNEL
212 #define INADDR_NONE __IPADDR(0xffffffff) /* -1 return */
213 #endif
214
215 #define INADDR_UNSPEC_GROUP __IPADDR(0xe0000000) /* 224.0.0.0 */
216 #define INADDR_ALLHOSTS_GROUP __IPADDR(0xe0000001) /* 224.0.0.1 */
217 #define INADDR_ALLRTRS_GROUP __IPADDR(0xe0000002) /* 224.0.0.2 */
218 #define INADDR_MAX_LOCAL_GROUP __IPADDR(0xe00000ff) /* 224.0.0.255 */
219
220 #define IN_LOOPBACKNET 127 /* official! */
221
222 /*
223 * Socket address, internet style.
224 */
225 struct sockaddr_in {
226 uint8_t sin_len;
227 sa_family_t sin_family;
228 in_port_t sin_port;
229 struct in_addr sin_addr;
230 __int8_t sin_zero[8];
231 };
232
233 #define INET_ADDRSTRLEN 16
234
235 /*
236 * Structure used to describe IP options.
237 * Used to store options internally, to pass them to a process,
238 * or to restore options retrieved earlier.
239 * The ip_dst is used for the first-hop gateway when using a source route
240 * (this gets put into the header proper).
241 */
242 struct ip_opts {
243 struct in_addr ip_dst; /* first hop, 0 w/o src rt */
244 #if defined(__cplusplus)
245 __int8_t Ip_opts[40]; /* actually variable in size */
246 #else
247 __int8_t ip_opts[40]; /* actually variable in size */
248 #endif
249 };
250
251 /*
252 * Options for use with [gs]etsockopt at the IP level.
253 * First word of comment is data type; bool is stored in int.
254 */
255 #define IP_OPTIONS 1 /* buf/ip_opts; set/get IP options */
256 #define IP_HDRINCL 2 /* int; header is included with data */
257 #define IP_TOS 3 /* int; IP type of service and preced. */
258 #define IP_TTL 4 /* int; IP time to live */
259 #define IP_RECVOPTS 5 /* bool; receive all IP opts w/dgram */
260 #define IP_RECVRETOPTS 6 /* bool; receive IP opts for response */
261 #define IP_RECVDSTADDR 7 /* bool; receive IP dst addr w/dgram */
262 #define IP_RETOPTS 8 /* ip_opts; set/get IP options */
263 #define IP_MULTICAST_IF 9 /* in_addr; set/get IP multicast i/f */
264 #define IP_MULTICAST_TTL 10 /* u_char; set/get IP multicast ttl */
265 #define IP_MULTICAST_LOOP 11 /* u_char; set/get IP multicast loopback */
266 #define IP_ADD_MEMBERSHIP 12 /* ip_mreq; add an IP group membership */
267 #define IP_DROP_MEMBERSHIP 13 /* ip_mreq; drop an IP group membership */
268 #define IP_PORTRANGE 19 /* int; range to use for ephemeral port */
269 #define IP_RECVIF 20 /* bool; receive reception if w/dgram */
270 #define IP_ERRORMTU 21 /* int; get MTU of last xmit = EMSGSIZE */
271 #if 1 /*IPSEC*/
272 #define IP_IPSEC_POLICY 22 /* struct; get/set security policy */
273 #endif
274
275 /*
276 * Defaults and limits for options
277 */
278 #define IP_DEFAULT_MULTICAST_TTL 1 /* normally limit m'casts to 1 hop */
279 #define IP_DEFAULT_MULTICAST_LOOP 1 /* normally hear sends if a member */
280 #define IP_MAX_MEMBERSHIPS 20 /* per socket; must fit in one mbuf */
281
282 /*
283 * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
284 */
285 struct ip_mreq {
286 struct in_addr imr_multiaddr; /* IP multicast address of group */
287 struct in_addr imr_interface; /* local IP address of interface */
288 };
289
290 /*
291 * Argument for IP_PORTRANGE:
292 * - which range to search when port is unspecified at bind() or connect()
293 */
294 #define IP_PORTRANGE_DEFAULT 0 /* default range */
295 #define IP_PORTRANGE_HIGH 1 /* same as DEFAULT (FreeBSD compat) */
296 #define IP_PORTRANGE_LOW 2 /* use privileged range */
297
298 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)
299 /*
300 * Definitions for inet sysctl operations.
301 *
302 * Third level is protocol number.
303 * Fourth level is desired variable within that protocol.
304 */
305 #define IPPROTO_MAXID (IPPROTO_AH + 1) /* don't list to IPPROTO_MAX */
306
307 #define CTL_IPPROTO_NAMES { \
308 { "ip", CTLTYPE_NODE }, \
309 { "icmp", CTLTYPE_NODE }, \
310 { "igmp", CTLTYPE_NODE }, \
311 { "ggp", CTLTYPE_NODE }, \
312 { 0, 0 }, \
313 { 0, 0 }, \
314 { "tcp", CTLTYPE_NODE }, \
315 { 0, 0 }, \
316 { "egp", CTLTYPE_NODE }, \
317 { 0, 0 }, \
318 { 0, 0 }, \
319 { 0, 0 }, \
320 { "pup", CTLTYPE_NODE }, \
321 { 0, 0 }, \
322 { 0, 0 }, \
323 { 0, 0 }, \
324 { 0, 0 }, \
325 { "udp", CTLTYPE_NODE }, \
326 { 0, 0 }, \
327 { 0, 0 }, \
328 { 0, 0 }, \
329 { 0, 0 }, \
330 { "idp", CTLTYPE_NODE }, \
331 { 0, 0 }, \
332 { 0, 0 }, \
333 { 0, 0 }, \
334 { 0, 0 }, \
335 { 0, 0 }, \
336 { 0, 0 }, \
337 { 0, 0 }, \
338 { 0, 0 }, \
339 { 0, 0 }, \
340 { 0, 0 }, \
341 { 0, 0 }, \
342 { 0, 0 }, \
343 { 0, 0 }, \
344 { 0, 0 }, \
345 { 0, 0 }, \
346 { 0, 0 }, \
347 { 0, 0 }, \
348 { 0, 0 }, \
349 { 0, 0 }, \
350 { 0, 0 }, \
351 { 0, 0 }, \
352 { 0, 0 }, \
353 { 0, 0 }, \
354 { 0, 0 }, \
355 { 0, 0 }, \
356 { 0, 0 }, \
357 { 0, 0 }, \
358 { 0, 0 }, \
359 { "ipsec", CTLTYPE_NODE }, \
360 }
361
362 /*
363 * Names for IP sysctl objects
364 */
365 #define IPCTL_FORWARDING 1 /* act as router */
366 #define IPCTL_SENDREDIRECTS 2 /* may send redirects when forwarding */
367 #define IPCTL_DEFTTL 3 /* default TTL */
368 #ifdef notyet
369 #define IPCTL_DEFMTU 4 /* default MTU */
370 #endif
371 #define IPCTL_FORWSRCRT 5 /* forward source-routed packets */
372 #define IPCTL_DIRECTEDBCAST 6 /* default broadcast behavior */
373 #define IPCTL_ALLOWSRCRT 7 /* allow/drop all source-routed pkts */
374 #define IPCTL_SUBNETSARELOCAL 8 /* treat subnets as local addresses */
375 #define IPCTL_MTUDISC 9 /* allow path MTU discovery */
376 #define IPCTL_ANONPORTMIN 10 /* minimum ephemeral port */
377 #define IPCTL_ANONPORTMAX 11 /* maximum ephemeral port */
378 #define IPCTL_MTUDISCTIMEOUT 12 /* allow path MTU discovery */
379 #define IPCTL_MAXFLOWS 13 /* maximum ip flows allowed */
380 #define IPCTL_HOSTZEROBROADCAST 14 /* is host zero a broadcast addr? */
381 #define IPCTL_GIF_TTL 15 /* default TTL for gif encap packet */
382 #define IPCTL_LOWPORTMIN 16 /* minimum reserved port */
383 #define IPCTL_LOWPORTMAX 17 /* maximum reserved port */
384 #define IPCTL_MAXFRAGPACKETS 18 /* max packets reassembly queue */
385 #define IPCTL_GRE_TTL 19 /* default TTL for gre encap packet */
386 #define IPCTL_CHECKINTERFACE 20 /* drop pkts in from 'wrong' iface */
387 #define IPCTL_MAXID 21
388
389 #define IPCTL_NAMES { \
390 { 0, 0 }, \
391 { "forwarding", CTLTYPE_INT }, \
392 { "redirect", CTLTYPE_INT }, \
393 { "ttl", CTLTYPE_INT }, \
394 { "mtu", CTLTYPE_INT }, \
395 { "forwsrcrt", CTLTYPE_INT }, \
396 { "directed-broadcast", CTLTYPE_INT }, \
397 { "allowsrcrt", CTLTYPE_INT }, \
398 { "subnetsarelocal", CTLTYPE_INT }, \
399 { "mtudisc", CTLTYPE_INT }, \
400 { "anonportmin", CTLTYPE_INT }, \
401 { "anonportmax", CTLTYPE_INT }, \
402 { "mtudisctimeout", CTLTYPE_INT }, \
403 { "maxflows", CTLTYPE_INT }, \
404 { "hostzerobroadcast", CTLTYPE_INT }, \
405 { "gifttl", CTLTYPE_INT }, \
406 { "lowportmin", CTLTYPE_INT }, \
407 { "lowportmax", CTLTYPE_INT }, \
408 { "maxfragpackets", CTLTYPE_INT }, \
409 { "grettl", CTLTYPE_INT }, \
410 { "checkinterface", CTLTYPE_INT }, \
411 }
412 #endif /* !_POSIX_C_SOURCE && !_XOPEN_SOURCE */
413
414 /* INET6 stuff */
415 #define __KAME_NETINET_IN_H_INCLUDED_
416 #include <netinet6/in6.h>
417 #undef __KAME_NETINET_IN_H_INCLUDED_
418
419 #ifdef _KERNEL
420 /*
421 * in_cksum_phdr:
422 *
423 * Compute significant parts of the IPv4 checksum pseudo-header
424 * for use in a delayed TCP/UDP checksum calculation.
425 *
426 * Args:
427 *
428 * src Source IP address
429 * dst Destination IP address
430 * lenproto htons(proto-hdr-len + proto-number)
431 */
432 static __inline u_int16_t __attribute__((__unused__))
433 in_cksum_phdr(u_int32_t src, u_int32_t dst, u_int32_t lenproto)
434 {
435 u_int32_t sum;
436
437 sum = lenproto +
438 (u_int16_t)(src >> 16) +
439 (u_int16_t)(src /*& 0xffff*/) +
440 (u_int16_t)(dst >> 16) +
441 (u_int16_t)(dst /*& 0xffff*/);
442
443 sum = (u_int16_t)(sum >> 16) + (u_int16_t)(sum /*& 0xffff*/);
444
445 if (sum > 0xffff)
446 sum -= 0xffff;
447
448 return (sum);
449 }
450
451 /*
452 * in_cksum_addword:
453 *
454 * Add the two 16-bit network-order values, carry, and return.
455 */
456 static __inline u_int16_t __attribute__((__unused__))
457 in_cksum_addword(u_int16_t a, u_int16_t b)
458 {
459 u_int32_t sum = a + b;
460
461 if (sum > 0xffff)
462 sum -= 0xffff;
463
464 return (sum);
465 }
466
467 extern struct in_addr zeroin_addr;
468 extern u_char ip_protox[];
469
470 int in_broadcast __P((struct in_addr, struct ifnet *));
471 int in_canforward __P((struct in_addr));
472 int in_cksum __P((struct mbuf *, int));
473 int in4_cksum __P((struct mbuf *, u_int8_t, int, int));
474 void in_delayed_cksum __P((struct mbuf *));
475 int in_localaddr __P((struct in_addr));
476 void in_socktrim __P((struct sockaddr_in *));
477
478 #define in_hosteq(s,t) ((s).s_addr == (t).s_addr)
479 #define in_nullhost(x) ((x).s_addr == INADDR_ANY)
480
481 #define satosin(sa) ((struct sockaddr_in *)(sa))
482 #define sintosa(sin) ((struct sockaddr *)(sin))
483 #define ifatoia(ifa) ((struct in_ifaddr *)(ifa))
484 #endif /* _KERNEL */
485
486 #endif /* !_NETINET_IN_H_ */
487