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

/*
 * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * 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. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * 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_OSREFERENCE_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>
#include <sys/types.h>          /* XXX temporary hack to get u_ types */
#include <netinet/in.h>
#include <netinet/in_systm.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
#if 1
/* ECN RFC3168 obsoletes RFC2481, and these will be deprecated soon. */
#define IPTOS_CE                0x01
#define IPTOS_ECT               0x02
#endif

#define IPTOS_DSCP_SHIFT        2

/*
 * ECN (Explicit Congestion Notification) codepoints in RFC3168
 * mapped to the lower 2 bits of the TOS field.
 */
#define IPTOS_ECN_NOTECT        0x00    /* not-ECT */
#define IPTOS_ECN_ECT1          0x01    /* ECN-capable transport (1) */
#define IPTOS_ECN_ECT0          0x02    /* ECN-capable transport (0) */
#define IPTOS_ECN_CE            0x03    /* congestion experienced */
#define IPTOS_ECN_MASK          0x03    /* ECN field mask */

/*
 * 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

#ifdef PRIVATE
/*
 * Definitions of traffic class for use within wireless LAN.
 * Mainly used by AFP for backup. Not recommended for general use.
 */
#define IP_TCLASS_BE                    0x00    /* standard, best effort */
#define IP_TCLASS_BK                    0x20    /* Background, low priority */
#define IP_TCLASS_VI                    0x80    /* Interactive */
#define IP_TCLASS_VO                    0xc0    /* Signalling */

#endif
/*
 * 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       30              /* time to live for frags (seconds) */
#define IPTTLDEC        1               /* subtracted when forwarding */

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

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