ip.h revision 331722
1/*-
2 * Copyright (c) 1982, 1986, 1993
3 *	The Regents of the University of California.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 * 4. Neither the name of the University nor the names of its contributors
15 *    may be used to endorse or promote products derived from this software
16 *    without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 *	@(#)ip.h	8.2 (Berkeley) 6/1/94
31 * $FreeBSD: stable/11/sys/netinet/ip.h 331722 2018-03-29 02:50:57Z eadler $
32 */
33
34#ifndef _NETINET_IP_H_
35#define	_NETINET_IP_H_
36
37#include <sys/cdefs.h>
38
39/*
40 * Definitions for internet protocol version 4.
41 *
42 * Per RFC 791, September 1981.
43 */
44#define	IPVERSION	4
45
46/*
47 * Structure of an internet header, naked of options.
48 */
49struct ip {
50#if BYTE_ORDER == LITTLE_ENDIAN
51	u_char	ip_hl:4,		/* header length */
52		ip_v:4;			/* version */
53#endif
54#if BYTE_ORDER == BIG_ENDIAN
55	u_char	ip_v:4,			/* version */
56		ip_hl:4;		/* header length */
57#endif
58	u_char	ip_tos;			/* type of service */
59	u_short	ip_len;			/* total length */
60	u_short	ip_id;			/* identification */
61	u_short	ip_off;			/* fragment offset field */
62#define	IP_RF 0x8000			/* reserved fragment flag */
63#define	IP_DF 0x4000			/* dont fragment flag */
64#define	IP_MF 0x2000			/* more fragments flag */
65#define	IP_OFFMASK 0x1fff		/* mask for fragmenting bits */
66	u_char	ip_ttl;			/* time to live */
67	u_char	ip_p;			/* protocol */
68	u_short	ip_sum;			/* checksum */
69	struct	in_addr ip_src,ip_dst;	/* source and dest address */
70} __packed __aligned(2);
71
72#define	IP_MAXPACKET	65535		/* maximum packet size */
73
74/*
75 * Definitions for IP type of service (ip_tos).
76 */
77#define	IPTOS_LOWDELAY		0x10
78#define	IPTOS_THROUGHPUT	0x08
79#define	IPTOS_RELIABILITY	0x04
80#define	IPTOS_MINCOST		0x02
81
82/*
83 * Definitions for IP precedence (also in ip_tos) (deprecated).
84 */
85#define	IPTOS_PREC_NETCONTROL		IPTOS_DSCP_CS7
86#define	IPTOS_PREC_INTERNETCONTROL	IPTOS_DSCP_CS6
87#define	IPTOS_PREC_CRITIC_ECP		IPTOS_DSCP_CS5
88#define	IPTOS_PREC_FLASHOVERRIDE	IPTOS_DSCP_CS4
89#define	IPTOS_PREC_FLASH		IPTOS_DSCP_CS3
90#define	IPTOS_PREC_IMMEDIATE		IPTOS_DSCP_CS2
91#define	IPTOS_PREC_PRIORITY		IPTOS_DSCP_CS1
92#define	IPTOS_PREC_ROUTINE		IPTOS_DSCP_CS0
93
94/*
95 * Definitions for DiffServ Codepoints as per RFC2474 and RFC5865.
96 */
97#define	IPTOS_DSCP_CS0		0x00
98#define	IPTOS_DSCP_CS1		0x20
99#define	IPTOS_DSCP_AF11		0x28
100#define	IPTOS_DSCP_AF12		0x30
101#define	IPTOS_DSCP_AF13		0x38
102#define	IPTOS_DSCP_CS2		0x40
103#define	IPTOS_DSCP_AF21		0x48
104#define	IPTOS_DSCP_AF22		0x50
105#define	IPTOS_DSCP_AF23		0x58
106#define	IPTOS_DSCP_CS3		0x60
107#define	IPTOS_DSCP_AF31		0x68
108#define	IPTOS_DSCP_AF32		0x70
109#define	IPTOS_DSCP_AF33		0x78
110#define	IPTOS_DSCP_CS4		0x80
111#define	IPTOS_DSCP_AF41		0x88
112#define	IPTOS_DSCP_AF42		0x90
113#define	IPTOS_DSCP_AF43		0x98
114#define	IPTOS_DSCP_CS5		0xa0
115#define	IPTOS_DSCP_VA		0xb0
116#define	IPTOS_DSCP_EF		0xb8
117#define	IPTOS_DSCP_CS6		0xc0
118#define	IPTOS_DSCP_CS7		0xe0
119
120/*
121 * ECN (Explicit Congestion Notification) codepoints in RFC3168 mapped to the
122 * lower 2 bits of the TOS field.
123 */
124#define	IPTOS_ECN_NOTECT	0x00	/* not-ECT */
125#define	IPTOS_ECN_ECT1		0x01	/* ECN-capable transport (1) */
126#define	IPTOS_ECN_ECT0		0x02	/* ECN-capable transport (0) */
127#define	IPTOS_ECN_CE		0x03	/* congestion experienced */
128#define	IPTOS_ECN_MASK		0x03	/* ECN field mask */
129
130/*
131 * Definitions for options.
132 */
133#define	IPOPT_COPIED(o)		((o)&0x80)
134#define	IPOPT_CLASS(o)		((o)&0x60)
135#define	IPOPT_NUMBER(o)		((o)&0x1f)
136
137#define	IPOPT_CONTROL		0x00
138#define	IPOPT_RESERVED1		0x20
139#define	IPOPT_DEBMEAS		0x40
140#define	IPOPT_RESERVED2		0x60
141
142#define	IPOPT_EOL		0		/* end of option list */
143#define	IPOPT_NOP		1		/* no operation */
144
145#define	IPOPT_RR		7		/* record packet route */
146#define	IPOPT_TS		68		/* timestamp */
147#define	IPOPT_SECURITY		130		/* provide s,c,h,tcc */
148#define	IPOPT_LSRR		131		/* loose source route */
149#define	IPOPT_ESO		133		/* extended security */
150#define	IPOPT_CIPSO		134		/* commercial security */
151#define	IPOPT_SATID		136		/* satnet id */
152#define	IPOPT_SSRR		137		/* strict source route */
153#define	IPOPT_RA		148		/* router alert */
154
155/*
156 * Offsets to fields in options other than EOL and NOP.
157 */
158#define	IPOPT_OPTVAL		0		/* option ID */
159#define	IPOPT_OLEN		1		/* option length */
160#define	IPOPT_OFFSET		2		/* offset within option */
161#define	IPOPT_MINOFF		4		/* min value of above */
162
163/*
164 * Time stamp option structure.
165 */
166struct	ip_timestamp {
167	u_char	ipt_code;		/* IPOPT_TS */
168	u_char	ipt_len;		/* size of structure (variable) */
169	u_char	ipt_ptr;		/* index of current entry */
170#if BYTE_ORDER == LITTLE_ENDIAN
171	u_char	ipt_flg:4,		/* flags, see below */
172		ipt_oflw:4;		/* overflow counter */
173#endif
174#if BYTE_ORDER == BIG_ENDIAN
175	u_char	ipt_oflw:4,		/* overflow counter */
176		ipt_flg:4;		/* flags, see below */
177#endif
178	union ipt_timestamp {
179		uint32_t	ipt_time[1];	/* network format */
180		struct	ipt_ta {
181			struct in_addr ipt_addr;
182			uint32_t ipt_time;	/* network format */
183		} ipt_ta[1];
184	} ipt_timestamp;
185};
186
187/* Flag bits for ipt_flg. */
188#define	IPOPT_TS_TSONLY		0		/* timestamps only */
189#define	IPOPT_TS_TSANDADDR	1		/* timestamps and addresses */
190#define	IPOPT_TS_PRESPEC	3		/* specified modules only */
191
192/* Bits for security (not byte swapped). */
193#define	IPOPT_SECUR_UNCLASS	0x0000
194#define	IPOPT_SECUR_CONFID	0xf135
195#define	IPOPT_SECUR_EFTO	0x789a
196#define	IPOPT_SECUR_MMMM	0xbc4d
197#define	IPOPT_SECUR_RESTR	0xaf13
198#define	IPOPT_SECUR_SECRET	0xd788
199#define	IPOPT_SECUR_TOPSECRET	0x6bc5
200
201/*
202 * Internet implementation parameters.
203 */
204#define	MAXTTL		255		/* maximum time to live (seconds) */
205#define	IPDEFTTL	64		/* default ttl, from RFC 1340 */
206#define	IPFRAGTTL	60		/* time to live for frags, slowhz */
207#define	IPTTLDEC	1		/* subtracted when forwarding */
208#define	IP_MSS		576		/* default maximum segment size */
209
210/*
211 * This is the real IPv4 pseudo header, used for computing the TCP and UDP
212 * checksums. For the Internet checksum, struct ipovly can be used instead.
213 * For stronger checksums, the real thing must be used.
214 */
215struct ippseudo {
216	struct	in_addr	ippseudo_src;	/* source internet address */
217	struct	in_addr	ippseudo_dst;	/* destination internet address */
218	u_char		ippseudo_pad;	/* pad, must be zero */
219	u_char		ippseudo_p;	/* protocol */
220	u_short		ippseudo_len;	/* protocol length */
221};
222#endif
223