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

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