Home | History | Annotate | Line # | Download | only in netinet
in.h revision 1.40
      1 /*	$NetBSD: in.h,v 1.40 1999/06/26 06:16:47 sommerfeld 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_GRE		47		/* GRE encaps RFC 1701 */
     61 #define	IPPROTO_ESP		50 		/* encap. security payload */
     62 #define	IPPROTO_AH		51 		/* authentication header */
     63 #define IPPROTO_MOBILE		55		/* IP Mobility RFC 2004 */
     64 #define IPPROTO_IPV6_ICMP	58		/* IPv6 ICMP */
     65 #define	IPPROTO_EON		80		/* ISO cnlp */
     66 #define	IPPROTO_ENCAP		98		/* encapsulation header */
     67 #define IPPROTO_PIM		103		/* Protocol indep. multicast */
     68 #define IPPROTO_IPPCP		108		/* IP Payload Comp. Protocol */
     69 
     70 #define	IPPROTO_RAW		255		/* raw IP packet */
     71 #define	IPPROTO_MAX		256
     72 
     73 
     74 /*
     75  * Local port number conventions:
     76  *
     77  * Ports < IPPORT_RESERVED are reserved for privileged processes (e.g. root),
     78  * unless a kernel is compiled with IPNOPRIVPORTS defined.
     79  *
     80  * When a user does a bind(2) or connect(2) with a port number of zero,
     81  * a non-conflicting local port address is chosen.
     82  *
     83  * The default range is IPPORT_ANONMIX to IPPORT_ANONMAX, although
     84  * that is settable by sysctl(3); net.inet.ip.anonportmin and
     85  * net.inet.ip.anonportmax respectively.
     86  *
     87  * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
     88  * default assignment range.
     89  *
     90  * The value IP_PORTRANGE_DEFAULT causes the default behavior.
     91  *
     92  * The value IP_PORTRANGE_HIGH is the same as IP_PORTRANGE_DEFAULT,
     93  * and exists only for FreeBSD compatibility purposes.
     94  *
     95  * The value IP_PORTRANGE_LOW changes the range to the "low" are
     96  * that is (by convention) restricted to privileged processes.
     97  * This convention is based on "vouchsafe" principles only.
     98  * It is only secure if you trust the remote host to restrict these ports.
     99  * The range is IPPORT_RESERVEDMIN to IPPORT_RESERVEDMAX.
    100  */
    101 
    102 #define	IPPORT_RESERVED		1024
    103 #define	IPPORT_ANONMIN		49152
    104 #define	IPPORT_ANONMAX		65535
    105 #define	IPPORT_RESERVEDMIN	600
    106 #define	IPPORT_RESERVEDMAX	(IPPORT_RESERVED-1)
    107 
    108 /*
    109  * Internet address (a structure for historical reasons)
    110  */
    111 struct in_addr {
    112 	u_int32_t s_addr;
    113 };
    114 
    115 /*
    116  * Definitions of bits in internet address integers.
    117  * On subnets, the decomposition of addresses to host and net parts
    118  * is done according to subnet mask, not the masks here.
    119  *
    120  * By byte-swapping the constants, we avoid ever having to byte-swap IP
    121  * addresses inside the kernel.  Unfortunately, user-level programs rely
    122  * on these macros not doing byte-swapping.
    123  */
    124 #ifdef _KERNEL
    125 #define	__IPADDR(x)	((u_int32_t) htonl((u_int32_t)(x)))
    126 #else
    127 #define	__IPADDR(x)	((u_int32_t)(x))
    128 #endif
    129 
    130 #define	IN_CLASSA(i)		(((u_int32_t)(i) & __IPADDR(0x80000000)) == \
    131 				 __IPADDR(0x00000000))
    132 #define	IN_CLASSA_NET		__IPADDR(0xff000000)
    133 #define	IN_CLASSA_NSHIFT	24
    134 #define	IN_CLASSA_HOST		__IPADDR(0x00ffffff)
    135 #define	IN_CLASSA_MAX		128
    136 
    137 #define	IN_CLASSB(i)		(((u_int32_t)(i) & __IPADDR(0xc0000000)) == \
    138 				 __IPADDR(0x80000000))
    139 #define	IN_CLASSB_NET		__IPADDR(0xffff0000)
    140 #define	IN_CLASSB_NSHIFT	16
    141 #define	IN_CLASSB_HOST		__IPADDR(0x0000ffff)
    142 #define	IN_CLASSB_MAX		65536
    143 
    144 #define	IN_CLASSC(i)		(((u_int32_t)(i) & __IPADDR(0xe0000000)) == \
    145 				 __IPADDR(0xc0000000))
    146 #define	IN_CLASSC_NET		__IPADDR(0xffffff00)
    147 #define	IN_CLASSC_NSHIFT	8
    148 #define	IN_CLASSC_HOST		__IPADDR(0x000000ff)
    149 
    150 #define	IN_CLASSD(i)		(((u_int32_t)(i) & __IPADDR(0xf0000000)) == \
    151 				 __IPADDR(0xe0000000))
    152 /* These ones aren't really net and host fields, but routing needn't know. */
    153 #define	IN_CLASSD_NET		__IPADDR(0xf0000000)
    154 #define	IN_CLASSD_NSHIFT	28
    155 #define	IN_CLASSD_HOST		__IPADDR(0x0fffffff)
    156 #define	IN_MULTICAST(i)		IN_CLASSD(i)
    157 
    158 #define	IN_EXPERIMENTAL(i)	(((u_int32_t)(i) & __IPADDR(0xf0000000)) == \
    159 				 __IPADDR(0xf0000000))
    160 #define	IN_BADCLASS(i)		(((u_int32_t)(i) & __IPADDR(0xf0000000)) == \
    161 				 __IPADDR(0xf0000000))
    162 
    163 #define	IN_LOCAL_GROUP(i)	(((u_int32_t)(i) & __IPADDR(0xffffff00)) == \
    164 				 __IPADDR(0xe0000000))
    165 
    166 #define	INADDR_ANY		__IPADDR(0x00000000)
    167 #define	INADDR_LOOPBACK		__IPADDR(0x7f000001)
    168 #define	INADDR_BROADCAST	__IPADDR(0xffffffff)	/* must be masked */
    169 #ifndef _KERNEL
    170 #define	INADDR_NONE		__IPADDR(0xffffffff)	/* -1 return */
    171 #endif
    172 
    173 #define	INADDR_UNSPEC_GROUP	__IPADDR(0xe0000000)	/* 224.0.0.0 */
    174 #define	INADDR_ALLHOSTS_GROUP	__IPADDR(0xe0000001)	/* 224.0.0.1 */
    175 #define	INADDR_ALLRTRS_GROUP	__IPADDR(0xe0000002)	/* 224.0.0.2 */
    176 #define	INADDR_MAX_LOCAL_GROUP	__IPADDR(0xe00000ff)	/* 224.0.0.255 */
    177 
    178 #define	IN_LOOPBACKNET		127			/* official! */
    179 
    180 /*
    181  * Socket address, internet style.
    182  */
    183 struct sockaddr_in {
    184 	u_int8_t  sin_len;
    185 	u_int8_t  sin_family;
    186 	u_int16_t sin_port;
    187 	struct	  in_addr sin_addr;
    188 	int8_t	  sin_zero[8];
    189 };
    190 
    191 /*
    192  * Structure used to describe IP options.
    193  * Used to store options internally, to pass them to a process,
    194  * or to restore options retrieved earlier.
    195  * The ip_dst is used for the first-hop gateway when using a source route
    196  * (this gets put into the header proper).
    197  */
    198 struct ip_opts {
    199 	struct in_addr	ip_dst;		/* first hop, 0 w/o src rt */
    200 	int8_t		ip_opts[40];	/* actually variable in size */
    201 };
    202 
    203 /*
    204  * Options for use with [gs]etsockopt at the IP level.
    205  * First word of comment is data type; bool is stored in int.
    206  */
    207 #define	IP_OPTIONS		1    /* buf/ip_opts; set/get IP options */
    208 #define	IP_HDRINCL		2    /* int; header is included with data */
    209 #define	IP_TOS			3    /* int; IP type of service and preced. */
    210 #define	IP_TTL			4    /* int; IP time to live */
    211 #define	IP_RECVOPTS		5    /* bool; receive all IP opts w/dgram */
    212 #define	IP_RECVRETOPTS		6    /* bool; receive IP opts for response */
    213 #define	IP_RECVDSTADDR		7    /* bool; receive IP dst addr w/dgram */
    214 #define	IP_RETOPTS		8    /* ip_opts; set/get IP options */
    215 #define	IP_MULTICAST_IF		9    /* in_addr; set/get IP multicast i/f  */
    216 #define	IP_MULTICAST_TTL	10   /* u_char; set/get IP multicast ttl */
    217 #define	IP_MULTICAST_LOOP	11   /* u_char; set/get IP multicast loopback */
    218 #define	IP_ADD_MEMBERSHIP	12   /* ip_mreq; add an IP group membership */
    219 #define	IP_DROP_MEMBERSHIP	13   /* ip_mreq; drop an IP group membership */
    220 #define IP_PORTRANGE		19   /* int; range to use for ephemeral port */
    221 #define	IP_RECVIF		20   /* bool; receive reception if w/dgram */
    222 #define	IP_ERRORMTU		21   /* int; get MTU of last xmit = EMSGSIZE */
    223 
    224 /*
    225  * Defaults and limits for options
    226  */
    227 #define	IP_DEFAULT_MULTICAST_TTL  1	/* normally limit m'casts to 1 hop  */
    228 #define	IP_DEFAULT_MULTICAST_LOOP 1	/* normally hear sends if a member  */
    229 #define	IP_MAX_MEMBERSHIPS	20	/* per socket; must fit in one mbuf */
    230 
    231 /*
    232  * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
    233  */
    234 struct ip_mreq {
    235 	struct	in_addr imr_multiaddr;	/* IP multicast address of group */
    236 	struct	in_addr imr_interface;	/* local IP address of interface */
    237 };
    238 
    239 /*
    240  * Argument for IP_PORTRANGE:
    241  * - which range to search when port is unspecified at bind() or connect()
    242  */
    243 #define	IP_PORTRANGE_DEFAULT	0	/* default range */
    244 #define	IP_PORTRANGE_HIGH	1	/* same as DEFAULT (FreeBSD compat) */
    245 #define	IP_PORTRANGE_LOW	2	/* use privileged range */
    246 
    247 #if !defined(_XOPEN_SOURCE)
    248 /*
    249  * Definitions for inet sysctl operations.
    250  *
    251  * Third level is protocol number.
    252  * Fourth level is desired variable within that protocol.
    253  */
    254 #define	IPPROTO_MAXID	(IPPROTO_IDP + 1)	/* don't list to IPPROTO_MAX */
    255 
    256 #define	CTL_IPPROTO_NAMES { \
    257 	{ "ip", CTLTYPE_NODE }, \
    258 	{ "icmp", CTLTYPE_NODE }, \
    259 	{ "igmp", CTLTYPE_NODE }, \
    260 	{ "ggp", CTLTYPE_NODE }, \
    261 	{ 0, 0 }, \
    262 	{ 0, 0 }, \
    263 	{ "tcp", CTLTYPE_NODE }, \
    264 	{ 0, 0 }, \
    265 	{ "egp", CTLTYPE_NODE }, \
    266 	{ 0, 0 }, \
    267 	{ 0, 0 }, \
    268 	{ 0, 0 }, \
    269 	{ "pup", CTLTYPE_NODE }, \
    270 	{ 0, 0 }, \
    271 	{ 0, 0 }, \
    272 	{ 0, 0 }, \
    273 	{ 0, 0 }, \
    274 	{ "udp", CTLTYPE_NODE }, \
    275 	{ 0, 0 }, \
    276 	{ 0, 0 }, \
    277 	{ 0, 0 }, \
    278 	{ 0, 0 }, \
    279 	{ "idp", CTLTYPE_NODE }, \
    280 }
    281 
    282 /*
    283  * Names for IP sysctl objects
    284  */
    285 #define	IPCTL_FORWARDING	1	/* act as router */
    286 #define	IPCTL_SENDREDIRECTS	2	/* may send redirects when forwarding */
    287 #define	IPCTL_DEFTTL		3	/* default TTL */
    288 #ifdef notyet
    289 #define	IPCTL_DEFMTU		4	/* default MTU */
    290 #endif
    291 #define	IPCTL_FORWSRCRT		5	/* forward source-routed packets */
    292 #define	IPCTL_DIRECTEDBCAST	6	/* default broadcast behavior */
    293 #define	IPCTL_ALLOWSRCRT	7	/* allow/drop all source-routed pkts */
    294 #define	IPCTL_SUBNETSARELOCAL	8	/* treat subnets as local addresses */
    295 #define	IPCTL_MTUDISC		9	/* allow path MTU discovery */
    296 #define	IPCTL_ANONPORTMIN      10	/* minimum ephemeral port */
    297 #define	IPCTL_ANONPORTMAX      11	/* maximum ephemeral port */
    298 #define	IPCTL_MTUDISCTIMEOUT   12	/* allow path MTU discovery */
    299 #define	IPCTL_MAXFLOWS         13	/* maximum ip flows allowed */
    300 #define	IPCTL_HOSTZEROBROADCAST 14	/* is host zero a broadcast addr? */
    301 #define	IPCTL_MAXID	       15
    302 
    303 #define	IPCTL_NAMES { \
    304 	{ 0, 0 }, \
    305 	{ "forwarding", CTLTYPE_INT }, \
    306 	{ "redirect", CTLTYPE_INT }, \
    307 	{ "ttl", CTLTYPE_INT }, \
    308 	{ "mtu", CTLTYPE_INT }, \
    309 	{ "forwsrcrt", CTLTYPE_INT }, \
    310 	{ "directed-broadcast", CTLTYPE_INT }, \
    311 	{ "allowsrcrt", CTLTYPE_INT }, \
    312 	{ "subnetsarelocal", CTLTYPE_INT }, \
    313 	{ "mtudisc", CTLTYPE_INT }, \
    314 	{ "anonportmin", CTLTYPE_INT }, \
    315 	{ "anonportmax", CTLTYPE_INT }, \
    316 	{ "mtudisctimeout", CTLTYPE_INT }, \
    317 	{ "maxflows", CTLTYPE_INT }, \
    318 	{ "hostzerobroadcast", CTLTYPE_INT }, \
    319 }
    320 #endif /* !_XOPEN_SOURCE */
    321 
    322 
    323 #ifdef _KERNEL
    324 extern	struct in_addr zeroin_addr;
    325 
    326 int	in_broadcast __P((struct in_addr, struct ifnet *));
    327 int	in_canforward __P((struct in_addr));
    328 int	in_cksum __P((struct mbuf *, int));
    329 int	in_localaddr __P((struct in_addr));
    330 void	in_socktrim __P((struct sockaddr_in *));
    331 
    332 #define	in_hosteq(s,t)	((s).s_addr == (t).s_addr)
    333 #define	in_nullhost(x)	((x).s_addr == INADDR_ANY)
    334 
    335 #define	satosin(sa)	((struct sockaddr_in *)(sa))
    336 #define	sintosa(sin)	((struct sockaddr *)(sin))
    337 #define	ifatoia(ifa)	((struct in_ifaddr *)(ifa))
    338 #endif /* _KERNEL */
    339 
    340 #endif /* !_NETINET_IN_H_ */
    341