Home | History | Annotate | Line # | Download | only in netinet
in.h revision 1.57
      1 /*	$NetBSD: in.h,v 1.57 2002/05/12 23:04:15 kleink 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 #include <sys/ansi.h>
     47 
     48 #ifndef in_addr_t
     49 typedef __in_addr_t	in_addr_t;
     50 #define	in_addr_t	__in_addr_t
     51 #endif
     52 
     53 #ifndef in_port_t
     54 typedef __in_port_t	in_port_t;
     55 #define	in_port_t	__in_port_t
     56 #endif
     57 
     58 #ifndef sa_family_t
     59 typedef __sa_family_t	sa_family_t;
     60 #define	sa_family_t	__sa_family_t
     61 #endif
     62 
     63 /*
     64  * Protocols
     65  */
     66 #define	IPPROTO_IP		0		/* dummy for IP */
     67 #define	IPPROTO_HOPOPTS		0		/* IP6 hop-by-hop options */
     68 #define	IPPROTO_ICMP		1		/* control message protocol */
     69 #define	IPPROTO_IGMP		2		/* group mgmt protocol */
     70 #define	IPPROTO_GGP		3		/* gateway^2 (deprecated) */
     71 #define	IPPROTO_IPV4		4 		/* IP header */
     72 #define	IPPROTO_IPIP		4		/* IP inside IP */
     73 #define	IPPROTO_TCP		6		/* tcp */
     74 #define	IPPROTO_EGP		8		/* exterior gateway protocol */
     75 #define	IPPROTO_PUP		12		/* pup */
     76 #define	IPPROTO_UDP		17		/* user datagram protocol */
     77 #define	IPPROTO_IDP		22		/* xns idp */
     78 #define	IPPROTO_TP		29 		/* tp-4 w/ class negotiation */
     79 #define	IPPROTO_IPV6		41		/* IP6 header */
     80 #define	IPPROTO_ROUTING		43		/* IP6 routing header */
     81 #define	IPPROTO_FRAGMENT	44		/* IP6 fragmentation header */
     82 #define	IPPROTO_RSVP		46		/* resource reservation */
     83 #define	IPPROTO_GRE		47		/* GRE encaps RFC 1701 */
     84 #define	IPPROTO_ESP		50 		/* encap. security payload */
     85 #define	IPPROTO_AH		51 		/* authentication header */
     86 #define	IPPROTO_MOBILE		55		/* IP Mobility RFC 2004 */
     87 #define	IPPROTO_IPV6_ICMP	58		/* IPv6 ICMP */
     88 #define	IPPROTO_ICMPV6		58		/* ICMP6 */
     89 #define	IPPROTO_NONE		59		/* IP6 no next header */
     90 #define	IPPROTO_DSTOPTS		60		/* IP6 destination option */
     91 #define	IPPROTO_EON		80		/* ISO cnlp */
     92 #define	IPPROTO_ENCAP		98		/* encapsulation header */
     93 #define	IPPROTO_PIM		103		/* Protocol indep. multicast */
     94 #define	IPPROTO_IPCOMP		108		/* IP Payload Comp. Protocol */
     95 #define	IPPROTO_VRRP		112		/* VRRP RFC 2338 */
     96 
     97 #define	IPPROTO_RAW		255		/* raw IP packet */
     98 #define	IPPROTO_MAX		256
     99 
    100 /* last return value of *_input(), meaning "all job for this pkt is done".  */
    101 #define	IPPROTO_DONE		257
    102 
    103 
    104 /*
    105  * Local port number conventions:
    106  *
    107  * Ports < IPPORT_RESERVED are reserved for privileged processes (e.g. root),
    108  * unless a kernel is compiled with IPNOPRIVPORTS defined.
    109  *
    110  * When a user does a bind(2) or connect(2) with a port number of zero,
    111  * a non-conflicting local port address is chosen.
    112  *
    113  * The default range is IPPORT_ANONMIN to IPPORT_ANONMAX, although
    114  * that is settable by sysctl(3); net.inet.ip.anonportmin and
    115  * net.inet.ip.anonportmax respectively.
    116  *
    117  * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
    118  * default assignment range.
    119  *
    120  * The value IP_PORTRANGE_DEFAULT causes the default behavior.
    121  *
    122  * The value IP_PORTRANGE_HIGH is the same as IP_PORTRANGE_DEFAULT,
    123  * and exists only for FreeBSD compatibility purposes.
    124  *
    125  * The value IP_PORTRANGE_LOW changes the range to the "low" are
    126  * that is (by convention) restricted to privileged processes.
    127  * This convention is based on "vouchsafe" principles only.
    128  * It is only secure if you trust the remote host to restrict these ports.
    129  * The range is IPPORT_RESERVEDMIN to IPPORT_RESERVEDMAX.
    130  */
    131 
    132 #define	IPPORT_RESERVED		1024
    133 #define	IPPORT_ANONMIN		49152
    134 #define	IPPORT_ANONMAX		65535
    135 #define	IPPORT_RESERVEDMIN	600
    136 #define	IPPORT_RESERVEDMAX	(IPPORT_RESERVED-1)
    137 
    138 /*
    139  * Internet address (a structure for historical reasons)
    140  */
    141 struct in_addr {
    142 	in_addr_t s_addr;
    143 } __attribute__((__packed__));
    144 
    145 /*
    146  * Definitions of bits in internet address integers.
    147  * On subnets, the decomposition of addresses to host and net parts
    148  * is done according to subnet mask, not the masks here.
    149  *
    150  * By byte-swapping the constants, we avoid ever having to byte-swap IP
    151  * addresses inside the kernel.  Unfortunately, user-level programs rely
    152  * on these macros not doing byte-swapping.
    153  */
    154 #ifdef _KERNEL
    155 #define	__IPADDR(x)	((u_int32_t) htonl((u_int32_t)(x)))
    156 #else
    157 #define	__IPADDR(x)	((u_int32_t)(x))
    158 #endif
    159 
    160 #define	IN_CLASSA(i)		(((u_int32_t)(i) & __IPADDR(0x80000000)) == \
    161 				 __IPADDR(0x00000000))
    162 #define	IN_CLASSA_NET		__IPADDR(0xff000000)
    163 #define	IN_CLASSA_NSHIFT	24
    164 #define	IN_CLASSA_HOST		__IPADDR(0x00ffffff)
    165 #define	IN_CLASSA_MAX		128
    166 
    167 #define	IN_CLASSB(i)		(((u_int32_t)(i) & __IPADDR(0xc0000000)) == \
    168 				 __IPADDR(0x80000000))
    169 #define	IN_CLASSB_NET		__IPADDR(0xffff0000)
    170 #define	IN_CLASSB_NSHIFT	16
    171 #define	IN_CLASSB_HOST		__IPADDR(0x0000ffff)
    172 #define	IN_CLASSB_MAX		65536
    173 
    174 #define	IN_CLASSC(i)		(((u_int32_t)(i) & __IPADDR(0xe0000000)) == \
    175 				 __IPADDR(0xc0000000))
    176 #define	IN_CLASSC_NET		__IPADDR(0xffffff00)
    177 #define	IN_CLASSC_NSHIFT	8
    178 #define	IN_CLASSC_HOST		__IPADDR(0x000000ff)
    179 
    180 #define	IN_CLASSD(i)		(((u_int32_t)(i) & __IPADDR(0xf0000000)) == \
    181 				 __IPADDR(0xe0000000))
    182 /* These ones aren't really net and host fields, but routing needn't know. */
    183 #define	IN_CLASSD_NET		__IPADDR(0xf0000000)
    184 #define	IN_CLASSD_NSHIFT	28
    185 #define	IN_CLASSD_HOST		__IPADDR(0x0fffffff)
    186 #define	IN_MULTICAST(i)		IN_CLASSD(i)
    187 
    188 #define	IN_EXPERIMENTAL(i)	(((u_int32_t)(i) & __IPADDR(0xf0000000)) == \
    189 				 __IPADDR(0xf0000000))
    190 #define	IN_BADCLASS(i)		(((u_int32_t)(i) & __IPADDR(0xf0000000)) == \
    191 				 __IPADDR(0xf0000000))
    192 
    193 #define	IN_LOCAL_GROUP(i)	(((u_int32_t)(i) & __IPADDR(0xffffff00)) == \
    194 				 __IPADDR(0xe0000000))
    195 
    196 #define	INADDR_ANY		__IPADDR(0x00000000)
    197 #define	INADDR_LOOPBACK		__IPADDR(0x7f000001)
    198 #define	INADDR_BROADCAST	__IPADDR(0xffffffff)	/* must be masked */
    199 #ifndef _KERNEL
    200 #define	INADDR_NONE		__IPADDR(0xffffffff)	/* -1 return */
    201 #endif
    202 
    203 #define	INADDR_UNSPEC_GROUP	__IPADDR(0xe0000000)	/* 224.0.0.0 */
    204 #define	INADDR_ALLHOSTS_GROUP	__IPADDR(0xe0000001)	/* 224.0.0.1 */
    205 #define	INADDR_ALLRTRS_GROUP	__IPADDR(0xe0000002)	/* 224.0.0.2 */
    206 #define	INADDR_MAX_LOCAL_GROUP	__IPADDR(0xe00000ff)	/* 224.0.0.255 */
    207 
    208 #define	IN_LOOPBACKNET		127			/* official! */
    209 
    210 /*
    211  * Socket address, internet style.
    212  */
    213 struct sockaddr_in {
    214 	u_int8_t	sin_len;
    215 	sa_family_t	sin_family;
    216 	in_port_t	sin_port;
    217 	struct in_addr	sin_addr;
    218 	int8_t		sin_zero[8];
    219 };
    220 
    221 #define	INET_ADDRSTRLEN                 16
    222 
    223 /*
    224  * Structure used to describe IP options.
    225  * Used to store options internally, to pass them to a process,
    226  * or to restore options retrieved earlier.
    227  * The ip_dst is used for the first-hop gateway when using a source route
    228  * (this gets put into the header proper).
    229  */
    230 struct ip_opts {
    231 	struct in_addr	ip_dst;		/* first hop, 0 w/o src rt */
    232 	int8_t		ip_opts[40];	/* actually variable in size */
    233 };
    234 
    235 /*
    236  * Options for use with [gs]etsockopt at the IP level.
    237  * First word of comment is data type; bool is stored in int.
    238  */
    239 #define	IP_OPTIONS		1    /* buf/ip_opts; set/get IP options */
    240 #define	IP_HDRINCL		2    /* int; header is included with data */
    241 #define	IP_TOS			3    /* int; IP type of service and preced. */
    242 #define	IP_TTL			4    /* int; IP time to live */
    243 #define	IP_RECVOPTS		5    /* bool; receive all IP opts w/dgram */
    244 #define	IP_RECVRETOPTS		6    /* bool; receive IP opts for response */
    245 #define	IP_RECVDSTADDR		7    /* bool; receive IP dst addr w/dgram */
    246 #define	IP_RETOPTS		8    /* ip_opts; set/get IP options */
    247 #define	IP_MULTICAST_IF		9    /* in_addr; set/get IP multicast i/f  */
    248 #define	IP_MULTICAST_TTL	10   /* u_char; set/get IP multicast ttl */
    249 #define	IP_MULTICAST_LOOP	11   /* u_char; set/get IP multicast loopback */
    250 #define	IP_ADD_MEMBERSHIP	12   /* ip_mreq; add an IP group membership */
    251 #define	IP_DROP_MEMBERSHIP	13   /* ip_mreq; drop an IP group membership */
    252 #define	IP_PORTRANGE		19   /* int; range to use for ephemeral port */
    253 #define	IP_RECVIF		20   /* bool; receive reception if w/dgram */
    254 #define	IP_ERRORMTU		21   /* int; get MTU of last xmit = EMSGSIZE */
    255 #if 1 /*IPSEC*/
    256 #define	IP_IPSEC_POLICY		22 /* struct; get/set security policy */
    257 #endif
    258 
    259 /*
    260  * Defaults and limits for options
    261  */
    262 #define	IP_DEFAULT_MULTICAST_TTL  1	/* normally limit m'casts to 1 hop  */
    263 #define	IP_DEFAULT_MULTICAST_LOOP 1	/* normally hear sends if a member  */
    264 #define	IP_MAX_MEMBERSHIPS	20	/* per socket; must fit in one mbuf */
    265 
    266 /*
    267  * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
    268  */
    269 struct ip_mreq {
    270 	struct	in_addr imr_multiaddr;	/* IP multicast address of group */
    271 	struct	in_addr imr_interface;	/* local IP address of interface */
    272 };
    273 
    274 /*
    275  * Argument for IP_PORTRANGE:
    276  * - which range to search when port is unspecified at bind() or connect()
    277  */
    278 #define	IP_PORTRANGE_DEFAULT	0	/* default range */
    279 #define	IP_PORTRANGE_HIGH	1	/* same as DEFAULT (FreeBSD compat) */
    280 #define	IP_PORTRANGE_LOW	2	/* use privileged range */
    281 
    282 #if !defined(_XOPEN_SOURCE)
    283 /*
    284  * Definitions for inet sysctl operations.
    285  *
    286  * Third level is protocol number.
    287  * Fourth level is desired variable within that protocol.
    288  */
    289 #define	IPPROTO_MAXID	(IPPROTO_AH + 1)	/* don't list to IPPROTO_MAX */
    290 
    291 #define	CTL_IPPROTO_NAMES { \
    292 	{ "ip", CTLTYPE_NODE }, \
    293 	{ "icmp", CTLTYPE_NODE }, \
    294 	{ "igmp", CTLTYPE_NODE }, \
    295 	{ "ggp", CTLTYPE_NODE }, \
    296 	{ 0, 0 }, \
    297 	{ 0, 0 }, \
    298 	{ "tcp", CTLTYPE_NODE }, \
    299 	{ 0, 0 }, \
    300 	{ "egp", CTLTYPE_NODE }, \
    301 	{ 0, 0 }, \
    302 	{ 0, 0 }, \
    303 	{ 0, 0 }, \
    304 	{ "pup", CTLTYPE_NODE }, \
    305 	{ 0, 0 }, \
    306 	{ 0, 0 }, \
    307 	{ 0, 0 }, \
    308 	{ 0, 0 }, \
    309 	{ "udp", CTLTYPE_NODE }, \
    310 	{ 0, 0 }, \
    311 	{ 0, 0 }, \
    312 	{ 0, 0 }, \
    313 	{ 0, 0 }, \
    314 	{ "idp", CTLTYPE_NODE }, \
    315 	{ 0, 0 }, \
    316 	{ 0, 0 }, \
    317 	{ 0, 0 }, \
    318 	{ 0, 0 }, \
    319 	{ 0, 0 }, \
    320 	{ 0, 0 }, \
    321 	{ 0, 0 }, \
    322 	{ 0, 0 }, \
    323 	{ 0, 0 }, \
    324 	{ 0, 0 }, \
    325 	{ 0, 0 }, \
    326 	{ 0, 0 }, \
    327 	{ 0, 0 }, \
    328 	{ 0, 0 }, \
    329 	{ 0, 0 }, \
    330 	{ 0, 0 }, \
    331 	{ 0, 0 }, \
    332 	{ 0, 0 }, \
    333 	{ 0, 0 }, \
    334 	{ 0, 0 }, \
    335 	{ 0, 0 }, \
    336 	{ 0, 0 }, \
    337 	{ 0, 0 }, \
    338 	{ 0, 0 }, \
    339 	{ 0, 0 }, \
    340 	{ 0, 0 }, \
    341 	{ 0, 0 }, \
    342 	{ 0, 0 }, \
    343 	{ "ipsec", CTLTYPE_NODE }, \
    344 }
    345 
    346 /*
    347  * Names for IP sysctl objects
    348  */
    349 #define	IPCTL_FORWARDING	1	/* act as router */
    350 #define	IPCTL_SENDREDIRECTS	2	/* may send redirects when forwarding */
    351 #define	IPCTL_DEFTTL		3	/* default TTL */
    352 #ifdef notyet
    353 #define	IPCTL_DEFMTU		4	/* default MTU */
    354 #endif
    355 #define	IPCTL_FORWSRCRT		5	/* forward source-routed packets */
    356 #define	IPCTL_DIRECTEDBCAST	6	/* default broadcast behavior */
    357 #define	IPCTL_ALLOWSRCRT	7	/* allow/drop all source-routed pkts */
    358 #define	IPCTL_SUBNETSARELOCAL	8	/* treat subnets as local addresses */
    359 #define	IPCTL_MTUDISC		9	/* allow path MTU discovery */
    360 #define	IPCTL_ANONPORTMIN      10	/* minimum ephemeral port */
    361 #define	IPCTL_ANONPORTMAX      11	/* maximum ephemeral port */
    362 #define	IPCTL_MTUDISCTIMEOUT   12	/* allow path MTU discovery */
    363 #define	IPCTL_MAXFLOWS         13	/* maximum ip flows allowed */
    364 #define	IPCTL_HOSTZEROBROADCAST 14	/* is host zero a broadcast addr? */
    365 #define	IPCTL_GIF_TTL 	       15	/* default TTL for gif encap packet */
    366 #define	IPCTL_LOWPORTMIN       16	/* minimum reserved port */
    367 #define	IPCTL_LOWPORTMAX       17	/* maximum reserved port */
    368 #define	IPCTL_MAXFRAGPACKETS   18	/* max packets reassembly queue */
    369 #define IPCTL_GRE_TTL          19	/* default TTL for gre encap packet */
    370 #define	IPCTL_MAXID	       20
    371 
    372 #define	IPCTL_NAMES { \
    373 	{ 0, 0 }, \
    374 	{ "forwarding", CTLTYPE_INT }, \
    375 	{ "redirect", CTLTYPE_INT }, \
    376 	{ "ttl", CTLTYPE_INT }, \
    377 	{ "mtu", CTLTYPE_INT }, \
    378 	{ "forwsrcrt", CTLTYPE_INT }, \
    379 	{ "directed-broadcast", CTLTYPE_INT }, \
    380 	{ "allowsrcrt", CTLTYPE_INT }, \
    381 	{ "subnetsarelocal", CTLTYPE_INT }, \
    382 	{ "mtudisc", CTLTYPE_INT }, \
    383 	{ "anonportmin", CTLTYPE_INT }, \
    384 	{ "anonportmax", CTLTYPE_INT }, \
    385 	{ "mtudisctimeout", CTLTYPE_INT }, \
    386 	{ "maxflows", CTLTYPE_INT }, \
    387 	{ "hostzerobroadcast", CTLTYPE_INT }, \
    388 	{ "gifttl", CTLTYPE_INT }, \
    389 	{ "lowportmin", CTLTYPE_INT }, \
    390 	{ "lowportmax", CTLTYPE_INT }, \
    391 	{ "maxfragpackets", CTLTYPE_INT }, \
    392 	{ "grettl", CTLTYPE_INT }, \
    393 }
    394 #endif /* !_XOPEN_SOURCE */
    395 
    396 /* INET6 stuff */
    397 #define	__KAME_NETINET_IN_H_INCLUDED_
    398 #include <netinet6/in6.h>
    399 #undef __KAME_NETINET_IN_H_INCLUDED_
    400 
    401 #ifdef _KERNEL
    402 /*
    403  * in_cksum_phdr:
    404  *
    405  *	Compute significant parts of the IPv4 checksum pseudo-header
    406  *	for use in a delayed TCP/UDP checksum calculation.
    407  *
    408  *	Args:
    409  *
    410  *		src		Source IP address
    411  *		dst		Destination IP address
    412  *		lenproto	htons(proto-hdr-len + proto-number)
    413  */
    414 static __inline u_int16_t __attribute__((__unused__))
    415 in_cksum_phdr(u_int32_t src, u_int32_t dst, u_int32_t lenproto)
    416 {
    417 	u_int32_t sum;
    418 
    419 	sum = lenproto +
    420 	      (u_int16_t)(src >> 16) +
    421 	      (u_int16_t)(src /*& 0xffff*/) +
    422 	      (u_int16_t)(dst >> 16) +
    423 	      (u_int16_t)(dst /*& 0xffff*/);
    424 
    425 	sum = (u_int16_t)(sum >> 16) + (u_int16_t)(sum /*& 0xffff*/);
    426 
    427 	if (sum > 0xffff)
    428 		sum -= 0xffff;
    429 
    430 	return (sum);
    431 }
    432 
    433 /*
    434  * in_cksum_addword:
    435  *
    436  *	Add the two 16-bit network-order values, carry, and return.
    437  */
    438 static __inline u_int16_t __attribute__((__unused__))
    439 in_cksum_addword(u_int16_t a, u_int16_t b)
    440 {
    441 	u_int32_t sum = a + b;
    442 
    443 	if (sum > 0xffff)
    444 		sum -= 0xffff;
    445 
    446 	return (sum);
    447 }
    448 
    449 extern	struct in_addr zeroin_addr;
    450 extern	u_char	ip_protox[];
    451 
    452 int	in_broadcast __P((struct in_addr, struct ifnet *));
    453 int	in_canforward __P((struct in_addr));
    454 int	in_cksum __P((struct mbuf *, int));
    455 int	in4_cksum __P((struct mbuf *, u_int8_t, int, int));
    456 void	in_delayed_cksum __P((struct mbuf *));
    457 int	in_localaddr __P((struct in_addr));
    458 void	in_socktrim __P((struct sockaddr_in *));
    459 
    460 #define	in_hosteq(s,t)	((s).s_addr == (t).s_addr)
    461 #define	in_nullhost(x)	((x).s_addr == INADDR_ANY)
    462 
    463 #define	satosin(sa)	((struct sockaddr_in *)(sa))
    464 #define	sintosa(sin)	((struct sockaddr *)(sin))
    465 #define	ifatoia(ifa)	((struct in_ifaddr *)(ifa))
    466 #endif /* _KERNEL */
    467 
    468 #endif /* !_NETINET_IN_H_ */
    469