in.h revision 13491
1/*
2 * Copyright (c) 1982, 1986, 1990, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 *	@(#)in.h	8.3 (Berkeley) 1/3/94
34 * $Id: in.h,v 1.13 1995/11/14 20:33:57 phk Exp $
35 */
36
37#ifndef _NETINET_IN_H_
38#define _NETINET_IN_H_
39
40/*
41 * Constants and structures defined by the internet system,
42 * Per RFC 790, September 1981, and numerous additions.
43 */
44
45/*
46 * Protocols
47 */
48#define	IPPROTO_IP		0		/* dummy for IP */
49#define	IPPROTO_ICMP		1		/* control message protocol */
50#define	IPPROTO_IGMP		2		/* group mgmt protocol */
51#define	IPPROTO_GGP		3		/* gateway^2 (deprecated) */
52#define IPPROTO_IPIP		4 		/* IP encapsulation in IP */
53#define	IPPROTO_TCP		6		/* tcp */
54#define	IPPROTO_EGP		8		/* exterior gateway protocol */
55#define	IPPROTO_PUP		12		/* pup */
56#define	IPPROTO_UDP		17		/* user datagram protocol */
57#define	IPPROTO_IDP		22		/* xns idp */
58#define	IPPROTO_TP		29 		/* tp-4 w/ class negotiation */
59#define IPPROTO_RSVP		46 		/* resource reservation */
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 * Range of ports for automatic assignment to local addresses that
79 * have not explicitly specified an address.
80 *
81 * These can be overridden at kernel config time, and are used to init
82 * sysctl variables.  The sysctl variables can be changed at runtime.
83 */
84#ifndef IPPORT_FIRSTAUTO
85#define	IPPORT_FIRSTAUTO	20000
86#endif
87#ifndef IPPORT_LASTAUTO
88#define	IPPORT_LASTAUTO		30000
89#endif
90
91/*
92 * Internet address (a structure for historical reasons)
93 */
94struct in_addr {
95	u_long s_addr;
96};
97
98/*
99 * Definitions of bits in internet address integers.
100 * On subnets, the decomposition of addresses to host and net parts
101 * is done according to subnet mask, not the masks here.
102 */
103#define	IN_CLASSA(i)		(((long)(i) & 0x80000000) == 0)
104#define	IN_CLASSA_NET		0xff000000
105#define	IN_CLASSA_NSHIFT	24
106#define	IN_CLASSA_HOST		0x00ffffff
107#define	IN_CLASSA_MAX		128
108
109#define	IN_CLASSB(i)		(((long)(i) & 0xc0000000) == 0x80000000)
110#define	IN_CLASSB_NET		0xffff0000
111#define	IN_CLASSB_NSHIFT	16
112#define	IN_CLASSB_HOST		0x0000ffff
113#define	IN_CLASSB_MAX		65536
114
115#define	IN_CLASSC(i)		(((long)(i) & 0xe0000000) == 0xc0000000)
116#define	IN_CLASSC_NET		0xffffff00
117#define	IN_CLASSC_NSHIFT	8
118#define	IN_CLASSC_HOST		0x000000ff
119
120#define	IN_CLASSD(i)		(((long)(i) & 0xf0000000) == 0xe0000000)
121#define	IN_CLASSD_NET		0xf0000000	/* These ones aren't really */
122#define	IN_CLASSD_NSHIFT	28		/* net and host fields, but */
123#define	IN_CLASSD_HOST		0x0fffffff	/* routing needn't know.    */
124#define	IN_MULTICAST(i)		IN_CLASSD(i)
125
126#define	IN_EXPERIMENTAL(i)	(((long)(i) & 0xf0000000) == 0xf0000000)
127#define	IN_BADCLASS(i)		(((long)(i) & 0xf0000000) == 0xf0000000)
128
129#define	INADDR_ANY		(u_long)0x00000000
130#define	INADDR_BROADCAST	(u_long)0xffffffff	/* must be masked */
131#ifndef KERNEL
132#define	INADDR_NONE		0xffffffff		/* -1 return */
133#endif
134
135#define	INADDR_UNSPEC_GROUP	(u_long)0xe0000000	/* 224.0.0.0 */
136#define	INADDR_ALLHOSTS_GROUP	(u_long)0xe0000001	/* 224.0.0.1 */
137#define	INADDR_MAX_LOCAL_GROUP	(u_long)0xe00000ff	/* 224.0.0.255 */
138
139#define	IN_LOOPBACKNET		127			/* official! */
140
141/*
142 * Socket address, internet style.
143 */
144struct sockaddr_in {
145	u_char	sin_len;
146	u_char	sin_family;
147	u_short	sin_port;
148	struct	in_addr sin_addr;
149	char	sin_zero[8];
150};
151
152/*
153 * Structure used to describe IP options.
154 * Used to store options internally, to pass them to a process,
155 * or to restore options retrieved earlier.
156 * The ip_dst is used for the first-hop gateway when using a source route
157 * (this gets put into the header proper).
158 */
159struct ip_opts {
160	struct	in_addr ip_dst;		/* first hop, 0 w/o src rt */
161	char	ip_opts[40];		/* actually variable in size */
162};
163
164/*
165 * Options for use with [gs]etsockopt at the IP level.
166 * First word of comment is data type; bool is stored in int.
167 */
168#define	IP_OPTIONS		1    /* buf/ip_opts; set/get IP options */
169#define	IP_HDRINCL		2    /* int; header is included with data */
170#define	IP_TOS			3    /* int; IP type of service and preced. */
171#define	IP_TTL			4    /* int; IP time to live */
172#define	IP_RECVOPTS		5    /* bool; receive all IP opts w/dgram */
173#define	IP_RECVRETOPTS		6    /* bool; receive IP opts for response */
174#define	IP_RECVDSTADDR		7    /* bool; receive IP dst addr w/dgram */
175#define	IP_RETOPTS		8    /* ip_opts; set/get IP options */
176#define	IP_MULTICAST_IF		9    /* u_char; set/get IP multicast i/f  */
177#define	IP_MULTICAST_TTL	10   /* u_char; set/get IP multicast ttl */
178#define	IP_MULTICAST_LOOP	11   /* u_char; set/get IP multicast loopback */
179#define	IP_ADD_MEMBERSHIP	12   /* ip_mreq; add an IP group membership */
180#define	IP_DROP_MEMBERSHIP	13   /* ip_mreq; drop an IP group membership */
181#define IP_MULTICAST_VIF	14   /* set/get IP mcast virt. iface */
182#define IP_RSVP_ON		15   /* enable RSVP in kernel */
183#define IP_RSVP_OFF		16   /* disable RSVP in kernel */
184#define IP_RSVP_VIF_ON		17   /* set RSVP per-vif socket */
185#define IP_RSVP_VIF_OFF		18   /* unset RSVP per-vif socket */
186
187/*
188 * Defaults and limits for options
189 */
190#define	IP_DEFAULT_MULTICAST_TTL  1	/* normally limit m'casts to 1 hop  */
191#define	IP_DEFAULT_MULTICAST_LOOP 1	/* normally hear sends if a member  */
192#define	IP_MAX_MEMBERSHIPS	20	/* per socket */
193
194/*
195 * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
196 */
197struct ip_mreq {
198	struct	in_addr imr_multiaddr;	/* IP multicast address of group */
199	struct	in_addr imr_interface;	/* local IP address of interface */
200};
201
202/*
203 * Definitions for inet sysctl operations.
204 *
205 * Third level is protocol number.
206 * Fourth level is desired variable within that protocol.
207 */
208#define	IPPROTO_MAXID	(IPPROTO_IDP + 1)	/* don't list to IPPROTO_MAX */
209
210#define	CTL_IPPROTO_NAMES { \
211	{ "ip", CTLTYPE_NODE }, \
212	{ "icmp", CTLTYPE_NODE }, \
213	{ "igmp", CTLTYPE_NODE }, \
214	{ "ggp", CTLTYPE_NODE }, \
215	{ 0, 0 }, \
216	{ 0, 0 }, \
217	{ "tcp", CTLTYPE_NODE }, \
218	{ 0, 0 }, \
219	{ "egp", CTLTYPE_NODE }, \
220	{ 0, 0 }, \
221	{ 0, 0 }, \
222	{ 0, 0 }, \
223	{ "pup", CTLTYPE_NODE }, \
224	{ 0, 0 }, \
225	{ 0, 0 }, \
226	{ 0, 0 }, \
227	{ 0, 0 }, \
228	{ "udp", CTLTYPE_NODE }, \
229	{ 0, 0 }, \
230	{ 0, 0 }, \
231	{ 0, 0 }, \
232	{ 0, 0 }, \
233	{ "idp", CTLTYPE_NODE }, \
234}
235
236/*
237 * Names for IP sysctl objects
238 */
239#define	IPCTL_FORWARDING	1	/* act as router */
240#define	IPCTL_SENDREDIRECTS	2	/* may send redirects when forwarding */
241#define	IPCTL_DEFTTL		3	/* default TTL */
242#ifdef notyet
243#define	IPCTL_DEFMTU		4	/* default MTU */
244#endif
245#define IPCTL_RTEXPIRE		5	/* cloned route expiration time */
246#define IPCTL_RTMINEXPIRE	6	/* min value for expiration time */
247#define IPCTL_RTMAXCACHE	7	/* trigger level for dynamic expire */
248#define	IPCTL_SOURCEROUTE	8	/* may perform source routes */
249#define	IPCTL_DIRECTEDBROADCAST	9	/* may re-broadcast received packets */
250#define IPCTL_INTRQMAXLEN	10	/* max length of netisr queue */
251#define IPCTL_INTRQDROPS	11	/* number of netisr q drops */
252#define	IPCTL_MAXID		12
253
254#define	IPCTL_NAMES { \
255	{ 0, 0 }, \
256	{ "forwarding", CTLTYPE_INT }, \
257	{ "redirect", CTLTYPE_INT }, \
258	{ "ttl", CTLTYPE_INT }, \
259	{ "mtu", CTLTYPE_INT }, \
260	{ "rtexpire", CTLTYPE_INT }, \
261	{ "rtminexpire", CTLTYPE_INT }, \
262	{ "rtmaxcache", CTLTYPE_INT }, \
263	{ "sourceroute", CTLTYPE_INT }, \
264 	{ "directed-broadcast", CTLTYPE_INT }, \
265	{ "intr-queue-maxlen", CTLTYPE_INT }, \
266	{ "intr-queue-drops", CTLTYPE_INT }, \
267}
268
269
270#ifdef KERNEL
271struct ifnet; struct mbuf;	/* forward declarations for Standard C */
272
273int	 in_broadcast __P((struct in_addr, struct ifnet *));
274int	 in_canforward __P((struct in_addr));
275int	 in_cksum __P((struct mbuf *, int));
276int	 in_localaddr __P((struct in_addr));
277char 	*inet_ntoa __P((struct in_addr)); /* in libkern */
278#endif
279
280#endif
281
282