[apple/xnu.git] / bsd / netinet / ip.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1982, 1986, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)ip.h	8.2 (Berkeley) 6/1/94
 * $FreeBSD: src/sys/netinet/ip.h,v 1.17 1999/12/22 19:13:20 shin Exp $
 */

#ifndef _NETINET_IP_H_
#define _NETINET_IP_H_
#include <sys/appleapiopts.h>

/*
 * Definitions for internet protocol version 4.
 * Per RFC 791, September 1981.
 */
#define	IPVERSION	4

/*
 * Structure of an internet header, naked of options.
 */
struct ip {
#ifdef _IP_VHL
	u_char	ip_vhl;			/* version << 4 | header length >> 2 */
#else
#if BYTE_ORDER == LITTLE_ENDIAN
	u_int	ip_hl:4,		/* header length */
		ip_v:4;			/* version */
#endif
#if BYTE_ORDER == BIG_ENDIAN
	u_int	ip_v:4,			/* version */
		ip_hl:4;		/* header length */
#endif
#endif /* not _IP_VHL */
	u_char	ip_tos;			/* type of service */
	u_short	ip_len;			/* total length */
	u_short	ip_id;			/* identification */
	u_short	ip_off;			/* fragment offset field */
#define	IP_RF 0x8000			/* reserved fragment flag */
#define	IP_DF 0x4000			/* dont fragment flag */
#define	IP_MF 0x2000			/* more fragments flag */
#define	IP_OFFMASK 0x1fff		/* mask for fragmenting bits */
	u_char	ip_ttl;			/* time to live */
	u_char	ip_p;			/* protocol */
	u_short	ip_sum;			/* checksum */
	struct	in_addr ip_src,ip_dst;	/* source and dest address */
};

#ifdef _IP_VHL
#define	IP_MAKE_VHL(v, hl)	((v) << 4 | (hl))
#define	IP_VHL_HL(vhl)		((vhl) & 0x0f)
#define	IP_VHL_V(vhl)		((vhl) >> 4)
#define	IP_VHL_BORING		0x45
#endif

#define	IP_MAXPACKET	65535		/* maximum packet size */

/*
 * Definitions for IP type of service (ip_tos)
 */
#define	IPTOS_LOWDELAY		0x10
#define	IPTOS_THROUGHPUT	0x08
#define	IPTOS_RELIABILITY	0x04
#define	IPTOS_MINCOST		0x02
/* ECN bits proposed by Sally Floyd */
#define	IPTOS_CE		0x01	/* congestion experienced */
#define	IPTOS_ECT		0x02	/* ECN-capable transport */


/*
 * Definitions for IP precedence (also in ip_tos) (hopefully unused)
 */
#define	IPTOS_PREC_NETCONTROL		0xe0
#define	IPTOS_PREC_INTERNETCONTROL	0xc0
#define	IPTOS_PREC_CRITIC_ECP		0xa0
#define	IPTOS_PREC_FLASHOVERRIDE	0x80
#define	IPTOS_PREC_FLASH		0x60
#define	IPTOS_PREC_IMMEDIATE		0x40
#define	IPTOS_PREC_PRIORITY		0x20
#define	IPTOS_PREC_ROUTINE		0x00

/*
 * Definitions for options.
 */
#define	IPOPT_COPIED(o)		((o)&0x80)
#define	IPOPT_CLASS(o)		((o)&0x60)
#define	IPOPT_NUMBER(o)		((o)&0x1f)

#define	IPOPT_CONTROL		0x00
#define	IPOPT_RESERVED1		0x20
#define	IPOPT_DEBMEAS		0x40
#define	IPOPT_RESERVED2		0x60

#define	IPOPT_EOL		0		/* end of option list */
#define	IPOPT_NOP		1		/* no operation */

#define	IPOPT_RR		7		/* record packet route */
#define	IPOPT_TS		68		/* timestamp */
#define	IPOPT_SECURITY		130		/* provide s,c,h,tcc */
#define	IPOPT_LSRR		131		/* loose source route */
#define	IPOPT_SATID		136		/* satnet id */
#define	IPOPT_SSRR		137		/* strict source route */
#define	IPOPT_RA		148		/* router alert */

/*
 * Offsets to fields in options other than EOL and NOP.
 */
#define	IPOPT_OPTVAL		0		/* option ID */
#define	IPOPT_OLEN		1		/* option length */
#define IPOPT_OFFSET		2		/* offset within option */
#define	IPOPT_MINOFF		4		/* min value of above */

/*
 * Time stamp option structure.
 */
struct	ip_timestamp {
	u_char	ipt_code;		/* IPOPT_TS */
	u_char	ipt_len;		/* size of structure (variable) */
	u_char	ipt_ptr;		/* index of current entry */
#if BYTE_ORDER == LITTLE_ENDIAN
	u_int	ipt_flg:4,		/* flags, see below */
		ipt_oflw:4;		/* overflow counter */
#endif
#if BYTE_ORDER == BIG_ENDIAN
	u_int	ipt_oflw:4,		/* overflow counter */
		ipt_flg:4;		/* flags, see below */
#endif
	union ipt_timestamp {
		n_long	ipt_time[1];
		struct	ipt_ta {
			struct in_addr ipt_addr;
			n_long ipt_time;
		} ipt_ta[1];
	} ipt_timestamp;
};

/* flag bits for ipt_flg */
#define	IPOPT_TS_TSONLY		0		/* timestamps only */
#define	IPOPT_TS_TSANDADDR	1		/* timestamps and addresses */
#define	IPOPT_TS_PRESPEC	3		/* specified modules only */

/* bits for security (not byte swapped) */
#define	IPOPT_SECUR_UNCLASS	0x0000
#define	IPOPT_SECUR_CONFID	0xf135
#define	IPOPT_SECUR_EFTO	0x789a
#define	IPOPT_SECUR_MMMM	0xbc4d
#define	IPOPT_SECUR_RESTR	0xaf13
#define	IPOPT_SECUR_SECRET	0xd788
#define	IPOPT_SECUR_TOPSECRET	0x6bc5

/*
 * Internet implementation parameters.
 */
#define	MAXTTL		255		/* maximum time to live (seconds) */
#define	IPDEFTTL	64		/* default ttl, from RFC 1340 */
#define	IPFRAGTTL	60		/* time to live for frags, slowhz */
#define	IPTTLDEC	1		/* subtracted when forwarding */

#define	IP_MSS		576		/* default maximum segment size */

#endif
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/*
	26	* Copyright (c) 1982, 1986, 1993
	27	* The Regents of the University of California. All rights reserved.
	28	*
	29	* Redistribution and use in source and binary forms, with or without
	30	* modification, are permitted provided that the following conditions
	31	* are met:
	32	* 1. Redistributions of source code must retain the above copyright
	33	* notice, this list of conditions and the following disclaimer.
	34	* 2. Redistributions in binary form must reproduce the above copyright
	35	* notice, this list of conditions and the following disclaimer in the
	36	* documentation and/or other materials provided with the distribution.
	37	* 3. All advertising materials mentioning features or use of this software
	38	* must display the following acknowledgement:
	39	* This product includes software developed by the University of
	40	* California, Berkeley and its contributors.
	41	* 4. Neither the name of the University nor the names of its contributors
	42	* may be used to endorse or promote products derived from this software
	43	* without specific prior written permission.
	44	*
	45	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	46	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	47	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	48	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	49	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	50	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	51	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	52	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	53	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	54	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	55	* SUCH DAMAGE.
	56	*
	57	* @(#)ip.h 8.2 (Berkeley) 6/1/94
9bccf70c	58	* $FreeBSD: src/sys/netinet/ip.h,v 1.17 1999/12/22 19:13:20 shin Exp $
1c79356b A	59	*/
	60
	61	#ifndef _NETINET_IP_H_
	62	#define _NETINET_IP_H_
9bccf70c	63	#include <sys/appleapiopts.h>
1c79356b A	64
	65	/*
	66	* Definitions for internet protocol version 4.
	67	* Per RFC 791, September 1981.
	68	*/
	69	#define IPVERSION 4
	70
	71	/*
	72	* Structure of an internet header, naked of options.
	73	*/
	74	struct ip {
	75	#ifdef _IP_VHL
	76	u_char ip_vhl; /* version << 4 \| header length >> 2 */
	77	#else
	78	#if BYTE_ORDER == LITTLE_ENDIAN
	79	u_int ip_hl:4, /* header length */
	80	ip_v:4; /* version */
	81	#endif
	82	#if BYTE_ORDER == BIG_ENDIAN
	83	u_int ip_v:4, /* version */
	84	ip_hl:4; /* header length */
	85	#endif
	86	#endif /* not _IP_VHL */
	87	u_char ip_tos; /* type of service */
	88	u_short ip_len; /* total length */
	89	u_short ip_id; /* identification */
	90	u_short ip_off; /* fragment offset field */
	91	#define IP_RF 0x8000 /* reserved fragment flag */
	92	#define IP_DF 0x4000 /* dont fragment flag */
	93	#define IP_MF 0x2000 /* more fragments flag */
	94	#define IP_OFFMASK 0x1fff /* mask for fragmenting bits */
	95	u_char ip_ttl; /* time to live */
	96	u_char ip_p; /* protocol */
	97	u_short ip_sum; /* checksum */
	98	struct in_addr ip_src,ip_dst; /* source and dest address */
	99	};
	100
	101	#ifdef _IP_VHL
	102	#define IP_MAKE_VHL(v, hl) ((v) << 4 \| (hl))
	103	#define IP_VHL_HL(vhl) ((vhl) & 0x0f)
	104	#define IP_VHL_V(vhl) ((vhl) >> 4)
	105	#define IP_VHL_BORING 0x45
	106	#endif
	107
	108	#define IP_MAXPACKET 65535 /* maximum packet size */
	109
	110	/*
	111	* Definitions for IP type of service (ip_tos)
	112	*/
	113	#define IPTOS_LOWDELAY 0x10
	114	#define IPTOS_THROUGHPUT 0x08
	115	#define IPTOS_RELIABILITY 0x04
	116	#define IPTOS_MINCOST 0x02
1c79356b	117	/* ECN bits proposed by Sally Floyd */
9bccf70c A	118	#define IPTOS_CE 0x01 /* congestion experienced */
	119	#define IPTOS_ECT 0x02 /* ECN-capable transport */
	120
1c79356b A	121
	122	/*
	123	* Definitions for IP precedence (also in ip_tos) (hopefully unused)
	124	*/
	125	#define IPTOS_PREC_NETCONTROL 0xe0
	126	#define IPTOS_PREC_INTERNETCONTROL 0xc0
	127	#define IPTOS_PREC_CRITIC_ECP 0xa0
	128	#define IPTOS_PREC_FLASHOVERRIDE 0x80
	129	#define IPTOS_PREC_FLASH 0x60
	130	#define IPTOS_PREC_IMMEDIATE 0x40
	131	#define IPTOS_PREC_PRIORITY 0x20
	132	#define IPTOS_PREC_ROUTINE 0x00
	133
	134	/*
	135	* Definitions for options.
	136	*/
	137	#define IPOPT_COPIED(o) ((o)&0x80)
	138	#define IPOPT_CLASS(o) ((o)&0x60)
	139	#define IPOPT_NUMBER(o) ((o)&0x1f)
	140
	141	#define IPOPT_CONTROL 0x00
	142	#define IPOPT_RESERVED1 0x20
	143	#define IPOPT_DEBMEAS 0x40
	144	#define IPOPT_RESERVED2 0x60
	145
	146	#define IPOPT_EOL 0 /* end of option list */
	147	#define IPOPT_NOP 1 /* no operation */
	148
	149	#define IPOPT_RR 7 /* record packet route */
	150	#define IPOPT_TS 68 /* timestamp */
	151	#define IPOPT_SECURITY 130 /* provide s,c,h,tcc */
	152	#define IPOPT_LSRR 131 /* loose source route */
	153	#define IPOPT_SATID 136 /* satnet id */
	154	#define IPOPT_SSRR 137 /* strict source route */
	155	#define IPOPT_RA 148 /* router alert */
	156
	157	/*
	158	* Offsets to fields in options other than EOL and NOP.
	159	*/
	160	#define IPOPT_OPTVAL 0 /* option ID */
	161	#define IPOPT_OLEN 1 /* option length */
	162	#define IPOPT_OFFSET 2 /* offset within option */
	163	#define IPOPT_MINOFF 4 /* min value of above */
	164
	165	/*
	166	* Time stamp option structure.
	167	*/
	168	struct ip_timestamp {
	169	u_char ipt_code; /* IPOPT_TS */
	170	u_char ipt_len; /* size of structure (variable) */
	171	u_char ipt_ptr; /* index of current entry */
	172	#if BYTE_ORDER == LITTLE_ENDIAN
	173	u_int ipt_flg:4, /* flags, see below */
	174	ipt_oflw:4; /* overflow counter */
	175	#endif
	176	#if BYTE_ORDER == BIG_ENDIAN
	177	u_int ipt_oflw:4, /* overflow counter */
	178	ipt_flg:4; /* flags, see below */
	179	#endif
	180	union ipt_timestamp {
	181	n_long ipt_time[1];
	182	struct ipt_ta {
	183	struct in_addr ipt_addr;
	184	n_long ipt_time;
185	} ipt_ta[1];
186	} ipt_timestamp;
187	};
188
189	/* flag bits for ipt_flg */
190	#define IPOPT_TS_TSONLY 0 /* timestamps only */
191	#define IPOPT_TS_TSANDADDR 1 /* timestamps and addresses */
192	#define IPOPT_TS_PRESPEC 3 /* specified modules only */
193
194	/* bits for security (not byte swapped) */
195	#define IPOPT_SECUR_UNCLASS 0x0000
196	#define IPOPT_SECUR_CONFID 0xf135
197	#define IPOPT_SECUR_EFTO 0x789a
198	#define IPOPT_SECUR_MMMM 0xbc4d
199	#define IPOPT_SECUR_RESTR 0xaf13
200	#define IPOPT_SECUR_SECRET 0xd788
201	#define IPOPT_SECUR_TOPSECRET 0x6bc5
202
203	/*
204	* Internet implementation parameters.
205	*/
206	#define MAXTTL 255 /* maximum time to live (seconds) */
207	#define IPDEFTTL 64 /* default ttl, from RFC 1340 */
208	#define IPFRAGTTL 60 /* time to live for frags, slowhz */
209	#define IPTTLDEC 1 /* subtracted when forwarding */
210
211	#define IP_MSS 576 /* default maximum segment size */
212
213	#endif