xref: /freebsd/sys/netinet/in.h (revision 48991a368427cadb9cdac39581d1676c29619c52)
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.12 1995/11/01 17:18:26 wollman 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  * Internet address (a structure for historical reasons)
79  */
80 struct in_addr {
81 	u_long 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 #define	IN_CLASSA(i)		(((long)(i) & 0x80000000) == 0)
90 #define	IN_CLASSA_NET		0xff000000
91 #define	IN_CLASSA_NSHIFT	24
92 #define	IN_CLASSA_HOST		0x00ffffff
93 #define	IN_CLASSA_MAX		128
94 
95 #define	IN_CLASSB(i)		(((long)(i) & 0xc0000000) == 0x80000000)
96 #define	IN_CLASSB_NET		0xffff0000
97 #define	IN_CLASSB_NSHIFT	16
98 #define	IN_CLASSB_HOST		0x0000ffff
99 #define	IN_CLASSB_MAX		65536
100 
101 #define	IN_CLASSC(i)		(((long)(i) & 0xe0000000) == 0xc0000000)
102 #define	IN_CLASSC_NET		0xffffff00
103 #define	IN_CLASSC_NSHIFT	8
104 #define	IN_CLASSC_HOST		0x000000ff
105 
106 #define	IN_CLASSD(i)		(((long)(i) & 0xf0000000) == 0xe0000000)
107 #define	IN_CLASSD_NET		0xf0000000	/* These ones aren't really */
108 #define	IN_CLASSD_NSHIFT	28		/* net and host fields, but */
109 #define	IN_CLASSD_HOST		0x0fffffff	/* routing needn't know.    */
110 #define	IN_MULTICAST(i)		IN_CLASSD(i)
111 
112 #define	IN_EXPERIMENTAL(i)	(((long)(i) & 0xf0000000) == 0xf0000000)
113 #define	IN_BADCLASS(i)		(((long)(i) & 0xf0000000) == 0xf0000000)
114 
115 #define	INADDR_ANY		(u_long)0x00000000
116 #define	INADDR_BROADCAST	(u_long)0xffffffff	/* must be masked */
117 #ifndef KERNEL
118 #define	INADDR_NONE		0xffffffff		/* -1 return */
119 #endif
120 
121 #define	INADDR_UNSPEC_GROUP	(u_long)0xe0000000	/* 224.0.0.0 */
122 #define	INADDR_ALLHOSTS_GROUP	(u_long)0xe0000001	/* 224.0.0.1 */
123 #define	INADDR_MAX_LOCAL_GROUP	(u_long)0xe00000ff	/* 224.0.0.255 */
124 
125 #define	IN_LOOPBACKNET		127			/* official! */
126 
127 /*
128  * Socket address, internet style.
129  */
130 struct sockaddr_in {
131 	u_char	sin_len;
132 	u_char	sin_family;
133 	u_short	sin_port;
134 	struct	in_addr sin_addr;
135 	char	sin_zero[8];
136 };
137 
138 /*
139  * Structure used to describe IP options.
140  * Used to store options internally, to pass them to a process,
141  * or to restore options retrieved earlier.
142  * The ip_dst is used for the first-hop gateway when using a source route
143  * (this gets put into the header proper).
144  */
145 struct ip_opts {
146 	struct	in_addr ip_dst;		/* first hop, 0 w/o src rt */
147 	char	ip_opts[40];		/* actually variable in size */
148 };
149 
150 /*
151  * Options for use with [gs]etsockopt at the IP level.
152  * First word of comment is data type; bool is stored in int.
153  */
154 #define	IP_OPTIONS		1    /* buf/ip_opts; set/get IP options */
155 #define	IP_HDRINCL		2    /* int; header is included with data */
156 #define	IP_TOS			3    /* int; IP type of service and preced. */
157 #define	IP_TTL			4    /* int; IP time to live */
158 #define	IP_RECVOPTS		5    /* bool; receive all IP opts w/dgram */
159 #define	IP_RECVRETOPTS		6    /* bool; receive IP opts for response */
160 #define	IP_RECVDSTADDR		7    /* bool; receive IP dst addr w/dgram */
161 #define	IP_RETOPTS		8    /* ip_opts; set/get IP options */
162 #define	IP_MULTICAST_IF		9    /* u_char; set/get IP multicast i/f  */
163 #define	IP_MULTICAST_TTL	10   /* u_char; set/get IP multicast ttl */
164 #define	IP_MULTICAST_LOOP	11   /* u_char; set/get IP multicast loopback */
165 #define	IP_ADD_MEMBERSHIP	12   /* ip_mreq; add an IP group membership */
166 #define	IP_DROP_MEMBERSHIP	13   /* ip_mreq; drop an IP group membership */
167 #define IP_MULTICAST_VIF	14   /* set/get IP mcast virt. iface */
168 #define IP_RSVP_ON		15   /* enable RSVP in kernel */
169 #define IP_RSVP_OFF		16   /* disable RSVP in kernel */
170 #define IP_RSVP_VIF_ON		17   /* set RSVP per-vif socket */
171 #define IP_RSVP_VIF_OFF		18   /* unset RSVP per-vif socket */
172 
173 /*
174  * Defaults and limits for options
175  */
176 #define	IP_DEFAULT_MULTICAST_TTL  1	/* normally limit m'casts to 1 hop  */
177 #define	IP_DEFAULT_MULTICAST_LOOP 1	/* normally hear sends if a member  */
178 #define	IP_MAX_MEMBERSHIPS	20	/* per socket */
179 
180 /*
181  * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
182  */
183 struct ip_mreq {
184 	struct	in_addr imr_multiaddr;	/* IP multicast address of group */
185 	struct	in_addr imr_interface;	/* local IP address of interface */
186 };
187 
188 /*
189  * Definitions for inet sysctl operations.
190  *
191  * Third level is protocol number.
192  * Fourth level is desired variable within that protocol.
193  */
194 #define	IPPROTO_MAXID	(IPPROTO_IDP + 1)	/* don't list to IPPROTO_MAX */
195 
196 #define	CTL_IPPROTO_NAMES { \
197 	{ "ip", CTLTYPE_NODE }, \
198 	{ "icmp", CTLTYPE_NODE }, \
199 	{ "igmp", CTLTYPE_NODE }, \
200 	{ "ggp", CTLTYPE_NODE }, \
201 	{ 0, 0 }, \
202 	{ 0, 0 }, \
203 	{ "tcp", CTLTYPE_NODE }, \
204 	{ 0, 0 }, \
205 	{ "egp", CTLTYPE_NODE }, \
206 	{ 0, 0 }, \
207 	{ 0, 0 }, \
208 	{ 0, 0 }, \
209 	{ "pup", CTLTYPE_NODE }, \
210 	{ 0, 0 }, \
211 	{ 0, 0 }, \
212 	{ 0, 0 }, \
213 	{ 0, 0 }, \
214 	{ "udp", CTLTYPE_NODE }, \
215 	{ 0, 0 }, \
216 	{ 0, 0 }, \
217 	{ 0, 0 }, \
218 	{ 0, 0 }, \
219 	{ "idp", CTLTYPE_NODE }, \
220 }
221 
222 /*
223  * Names for IP sysctl objects
224  */
225 #define	IPCTL_FORWARDING	1	/* act as router */
226 #define	IPCTL_SENDREDIRECTS	2	/* may send redirects when forwarding */
227 #define	IPCTL_DEFTTL		3	/* default TTL */
228 #ifdef notyet
229 #define	IPCTL_DEFMTU		4	/* default MTU */
230 #endif
231 #define IPCTL_RTEXPIRE		5	/* cloned route expiration time */
232 #define IPCTL_RTMINEXPIRE	6	/* min value for expiration time */
233 #define IPCTL_RTMAXCACHE	7	/* trigger level for dynamic expire */
234 #define	IPCTL_SOURCEROUTE	8	/* may perform source routes */
235 #define	IPCTL_DIRECTEDBROADCAST	9	/* may re-broadcast received packets */
236 #define IPCTL_INTRQMAXLEN	10	/* max length of netisr queue */
237 #define IPCTL_INTRQDROPS	11	/* number of netisr q drops */
238 #define	IPCTL_MAXID		12
239 
240 #define	IPCTL_NAMES { \
241 	{ 0, 0 }, \
242 	{ "forwarding", CTLTYPE_INT }, \
243 	{ "redirect", CTLTYPE_INT }, \
244 	{ "ttl", CTLTYPE_INT }, \
245 	{ "mtu", CTLTYPE_INT }, \
246 	{ "rtexpire", CTLTYPE_INT }, \
247 	{ "rtminexpire", CTLTYPE_INT }, \
248 	{ "rtmaxcache", CTLTYPE_INT }, \
249 	{ "sourceroute", CTLTYPE_INT }, \
250  	{ "directed-broadcast", CTLTYPE_INT }, \
251 	{ "intr-queue-maxlen", CTLTYPE_INT }, \
252 	{ "intr-queue-drops", CTLTYPE_INT }, \
253 }
254 
255 
256 #ifdef KERNEL
257 struct ifnet; struct mbuf;	/* forward declarations for Standard C */
258 
259 int	 in_broadcast __P((struct in_addr, struct ifnet *));
260 int	 in_canforward __P((struct in_addr));
261 int	 in_cksum __P((struct mbuf *, int));
262 int	 in_localaddr __P((struct in_addr));
263 char 	*inet_ntoa __P((struct in_addr)); /* in libkern */
264 #endif
265 
266 #endif
267 
268