in.h revision 1.29 1 /* $NetBSD: in.h,v 1.29 1997/12/16 00:02:05 thorpej 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 /*
47 * Protocols
48 */
49 #define IPPROTO_IP 0 /* dummy for IP */
50 #define IPPROTO_ICMP 1 /* control message protocol */
51 #define IPPROTO_IGMP 2 /* group mgmt protocol */
52 #define IPPROTO_GGP 3 /* gateway^2 (deprecated) */
53 #define IPPROTO_IPIP 4 /* IP inside IP */
54 #define IPPROTO_TCP 6 /* tcp */
55 #define IPPROTO_EGP 8 /* exterior gateway protocol */
56 #define IPPROTO_PUP 12 /* pup */
57 #define IPPROTO_UDP 17 /* user datagram protocol */
58 #define IPPROTO_IDP 22 /* xns idp */
59 #define IPPROTO_TP 29 /* tp-4 w/ class negotiation */
60 #define IPPROTO_ESP 50 /* encap. security payload */
61 #define IPPROTO_AH 51 /* authentication header */
62 #define IPPROTO_EON 80 /* ISO cnlp */
63 #define IPPROTO_ENCAP 98 /* encapsulation header */
64
65 #define IPPROTO_RAW 255 /* raw IP packet */
66 #define IPPROTO_MAX 256
67
68
69 /*
70 * Local port number conventions:
71 * Ports < IPPORT_RESERVED are reserved for
72 * privileged processes (e.g. root).
73 * Ports > IPPORT_USERRESERVED are reserved
74 * for servers, not necessarily privileged.
75 */
76 #define IPPORT_RESERVED 1024
77 #define IPPORT_USERRESERVED 5000
78
79 /*
80 * Internet address (a structure for historical reasons)
81 */
82 struct in_addr {
83 u_int32_t s_addr;
84 };
85
86 /*
87 * Definitions of bits in internet address integers.
88 * On subnets, the decomposition of addresses to host and net parts
89 * is done according to subnet mask, not the masks here.
90 *
91 * By byte-swapping the constants, we avoid ever having to byte-swap IP
92 * addresses inside the kernel. Unfortunately, user-level programs rely
93 * on these macros not doing byte-swapping.
94 */
95 #ifdef _KERNEL
96 #define __IPADDR(x) ((u_int32_t) htonl((u_int32_t)(x)))
97 #else
98 #define __IPADDR(x) ((u_int32_t)(x))
99 #endif
100
101 #define IN_CLASSA(i) (((u_int32_t)(i) & __IPADDR(0x80000000)) == \
102 __IPADDR(0x00000000))
103 #define IN_CLASSA_NET __IPADDR(0xff000000)
104 #define IN_CLASSA_NSHIFT 24
105 #define IN_CLASSA_HOST __IPADDR(0x00ffffff)
106 #define IN_CLASSA_MAX 128
107
108 #define IN_CLASSB(i) (((u_int32_t)(i) & __IPADDR(0xc0000000)) == \
109 __IPADDR(0x80000000))
110 #define IN_CLASSB_NET __IPADDR(0xffff0000)
111 #define IN_CLASSB_NSHIFT 16
112 #define IN_CLASSB_HOST __IPADDR(0x0000ffff)
113 #define IN_CLASSB_MAX 65536
114
115 #define IN_CLASSC(i) (((u_int32_t)(i) & __IPADDR(0xe0000000)) == \
116 __IPADDR(0xc0000000))
117 #define IN_CLASSC_NET __IPADDR(0xffffff00)
118 #define IN_CLASSC_NSHIFT 8
119 #define IN_CLASSC_HOST __IPADDR(0x000000ff)
120
121 #define IN_CLASSD(i) (((u_int32_t)(i) & __IPADDR(0xf0000000)) == \
122 __IPADDR(0xe0000000))
123 /* These ones aren't really net and host fields, but routing needn't know. */
124 #define IN_CLASSD_NET __IPADDR(0xf0000000)
125 #define IN_CLASSD_NSHIFT 28
126 #define IN_CLASSD_HOST __IPADDR(0x0fffffff)
127 #define IN_MULTICAST(i) IN_CLASSD(i)
128
129 #define IN_EXPERIMENTAL(i) (((u_int32_t)(i) & __IPADDR(0xf0000000)) == \
130 __IPADDR(0xf0000000))
131 #define IN_BADCLASS(i) (((u_int32_t)(i) & __IPADDR(0xf0000000)) == \
132 __IPADDR(0xf0000000))
133
134 #define IN_LOCAL_GROUP(i) (((u_int32_t)(i) & __IPADDR(0xffffff00)) == \
135 __IPADDR(0xe0000000))
136
137 #define INADDR_ANY __IPADDR(0x00000000)
138 #define INADDR_LOOPBACK __IPADDR(0x7f000001)
139 #define INADDR_BROADCAST __IPADDR(0xffffffff) /* must be masked */
140 #ifndef _KERNEL
141 #define INADDR_NONE __IPADDR(0xffffffff) /* -1 return */
142 #endif
143
144 #define INADDR_UNSPEC_GROUP __IPADDR(0xe0000000) /* 224.0.0.0 */
145 #define INADDR_ALLHOSTS_GROUP __IPADDR(0xe0000001) /* 224.0.0.1 */
146 #define INADDR_ALLRTRS_GROUP __IPADDR(0xe0000002) /* 224.0.0.2 */
147 #define INADDR_MAX_LOCAL_GROUP __IPADDR(0xe00000ff) /* 224.0.0.255 */
148
149 #define IN_LOOPBACKNET 127 /* official! */
150
151 /*
152 * Socket address, internet style.
153 */
154 struct sockaddr_in {
155 u_int8_t sin_len;
156 u_int8_t sin_family;
157 u_int16_t sin_port;
158 struct in_addr sin_addr;
159 int8_t sin_zero[8];
160 };
161
162 /*
163 * Structure used to describe IP options.
164 * Used to store options internally, to pass them to a process,
165 * or to restore options retrieved earlier.
166 * The ip_dst is used for the first-hop gateway when using a source route
167 * (this gets put into the header proper).
168 */
169 struct ip_opts {
170 struct in_addr ip_dst; /* first hop, 0 w/o src rt */
171 int8_t ip_opts[40]; /* actually variable in size */
172 };
173
174 /*
175 * Options for use with [gs]etsockopt at the IP level.
176 * First word of comment is data type; bool is stored in int.
177 */
178 #define IP_OPTIONS 1 /* buf/ip_opts; set/get IP options */
179 #define IP_HDRINCL 2 /* int; header is included with data */
180 #define IP_TOS 3 /* int; IP type of service and preced. */
181 #define IP_TTL 4 /* int; IP time to live */
182 #define IP_RECVOPTS 5 /* bool; receive all IP opts w/dgram */
183 #define IP_RECVRETOPTS 6 /* bool; receive IP opts for response */
184 #define IP_RECVDSTADDR 7 /* bool; receive IP dst addr w/dgram */
185 #define IP_RETOPTS 8 /* ip_opts; set/get IP options */
186 #define IP_MULTICAST_IF 9 /* in_addr; set/get IP multicast i/f */
187 #define IP_MULTICAST_TTL 10 /* u_char; set/get IP multicast ttl */
188 #define IP_MULTICAST_LOOP 11 /* u_char; set/get IP multicast loopback */
189 #define IP_ADD_MEMBERSHIP 12 /* ip_mreq; add an IP group membership */
190 #define IP_DROP_MEMBERSHIP 13 /* ip_mreq; drop an IP group membership */
191 #define IP_RECVIF 20 /* bool; receive reception if w/dgram */
192 #define IP_ERRORMTU 21 /* int; get MTU of last xmit = EMSGSIZE */
193
194 /*
195 * Defaults and limits for options
196 */
197 #define IP_DEFAULT_MULTICAST_TTL 1 /* normally limit m'casts to 1 hop */
198 #define IP_DEFAULT_MULTICAST_LOOP 1 /* normally hear sends if a member */
199 #define IP_MAX_MEMBERSHIPS 20 /* per socket; must fit in one mbuf */
200
201 /*
202 * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
203 */
204 struct ip_mreq {
205 struct in_addr imr_multiaddr; /* IP multicast address of group */
206 struct in_addr imr_interface; /* local IP address of interface */
207 };
208
209 /*
210 * Definitions for inet sysctl operations.
211 *
212 * Third level is protocol number.
213 * Fourth level is desired variable within that protocol.
214 */
215 #define IPPROTO_MAXID (IPPROTO_IDP + 1) /* don't list to IPPROTO_MAX */
216
217 #define CTL_IPPROTO_NAMES { \
218 { "ip", CTLTYPE_NODE }, \
219 { "icmp", CTLTYPE_NODE }, \
220 { "igmp", CTLTYPE_NODE }, \
221 { "ggp", CTLTYPE_NODE }, \
222 { 0, 0 }, \
223 { 0, 0 }, \
224 { "tcp", CTLTYPE_NODE }, \
225 { 0, 0 }, \
226 { "egp", CTLTYPE_NODE }, \
227 { 0, 0 }, \
228 { 0, 0 }, \
229 { 0, 0 }, \
230 { "pup", CTLTYPE_NODE }, \
231 { 0, 0 }, \
232 { 0, 0 }, \
233 { 0, 0 }, \
234 { 0, 0 }, \
235 { "udp", CTLTYPE_NODE }, \
236 { 0, 0 }, \
237 { 0, 0 }, \
238 { 0, 0 }, \
239 { 0, 0 }, \
240 { "idp", CTLTYPE_NODE }, \
241 }
242
243 /*
244 * Names for IP sysctl objects
245 */
246 #define IPCTL_FORWARDING 1 /* act as router */
247 #define IPCTL_SENDREDIRECTS 2 /* may send redirects when forwarding */
248 #define IPCTL_DEFTTL 3 /* default TTL */
249 #ifdef notyet
250 #define IPCTL_DEFMTU 4 /* default MTU */
251 #endif
252 #define IPCTL_FORWSRCRT 5 /* forward source-routed packets */
253 #define IPCTL_DIRECTEDBCAST 6 /* default broadcast behavior */
254 #define IPCTL_ALLOWSRCRT 7 /* allow/drop all source-routed pkts */
255 #define IPCTL_SUBNETSARELOCAL 8 /* treat subnets as local addresses */
256 #define IPCTL_MTUDISC 9 /* allow path MTU discovery */
257 #define IPCTL_MAXID 10
258
259 #define IPCTL_NAMES { \
260 { 0, 0 }, \
261 { "forwarding", CTLTYPE_INT }, \
262 { "redirect", CTLTYPE_INT }, \
263 { "ttl", CTLTYPE_INT }, \
264 { "mtu", CTLTYPE_INT }, \
265 { "forwsrcrt", CTLTYPE_INT }, \
266 { "directed-broadcast", CTLTYPE_INT }, \
267 { "allowsrcrt", CTLTYPE_INT }, \
268 { "subnetsarelocal", CTLTYPE_INT }, \
269 { "mtudisc", CTLTYPE_INT }, \
270 }
271
272
273 #ifdef _KERNEL
274 extern struct in_addr zeroin_addr;
275
276 int in_broadcast __P((struct in_addr, struct ifnet *));
277 int in_canforward __P((struct in_addr));
278 int in_cksum __P((struct mbuf *, int));
279 int in_localaddr __P((struct in_addr));
280 void in_socktrim __P((struct sockaddr_in *));
281
282 #define in_hosteq(s,t) ((s).s_addr == (t).s_addr)
283 #define in_nullhost(x) ((x).s_addr == INADDR_ANY)
284
285 #define satosin(sa) ((struct sockaddr_in *)(sa))
286 #define sintosa(sin) ((struct sockaddr *)(sin))
287 #define ifatoia(ifa) ((struct in_ifaddr *)(ifa))
288 #endif
289 #endif /* !_NETINET_IN_H_ */
290