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