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