xref: /illumos-gate/usr/src/uts/common/netinet/ip_icmp.h (revision 1f8b8a0145321ca42ee324565958ceb82a14ee7a)
1 /*
2  * Copyright 1997-2002 Sun Microsystems, Inc.  All rights reserved.
3  * Use is subject to license terms.
4  */
5 
6 /*
7  * Copyright (c) 1982, 1986, 1993
8  *      The Regents of the University of California.  All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by the University of
21  *      California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  */
38 
39 /*
40  * Interface Control Message Protocol Definitions.
41  * Per RFC 792, September 1981.
42  */
43 
44 #ifndef	_NETINET_IP_ICMP_H
45 #define	_NETINET_IP_ICMP_H
46 
47 #include <netinet/in_systm.h>
48 
49 /* ip_icmp.h 1.9 88/08/19 SMI; from UCB 7.3 12/7/87	*/
50 
51 #ifdef	__cplusplus
52 extern "C" {
53 #endif
54 
55 /*
56  * Structure of an icmp header.
57  */
58 struct icmp {
59 	uchar_t	icmp_type;		/* type of message, see below */
60 	uchar_t	icmp_code;		/* type sub code */
61 	uint16_t icmp_cksum;		/* ones complement cksum of struct */
62 	union {
63 		uchar_t ih_pptr;		/* ICMP_PARAMPROB */
64 		struct in_addr ih_gwaddr;	/* ICMP_REDIRECT */
65 		struct ih_idseq {
66 			uint16_t icd_id;
67 			uint16_t icd_seq;
68 		} ih_idseq;
69 		int ih_void;
70 
71 		/* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
72 		struct ih_pmtu {
73 			uint16_t ipm_void;
74 			uint16_t ipm_nextmtu;
75 		} ih_pmtu;
76 
77 		struct ih_rtradv {
78 			uchar_t irt_num_addrs;
79 			uchar_t irt_wpa;
80 			uint16_t irt_lifetime;
81 		} ih_rtradv;
82 	} icmp_hun;
83 #define	icmp_pptr	icmp_hun.ih_pptr
84 #define	icmp_gwaddr	icmp_hun.ih_gwaddr
85 #define	icmp_id		icmp_hun.ih_idseq.icd_id
86 #define	icmp_seq	icmp_hun.ih_idseq.icd_seq
87 #define	icmp_void	icmp_hun.ih_void
88 #define	icmp_pmvoid	icmp_hun.ih_pmtu.ipm_void
89 #define	icmp_nextmtu	icmp_hun.ih_pmtu.ipm_nextmtu
90 	union {
91 		struct id_ts {
92 			n_time its_otime;
93 			n_time its_rtime;
94 			n_time its_ttime;
95 		} id_ts;
96 		struct id_ip  {
97 			struct ip idi_ip;
98 			/* options and then 64 bits of data */
99 		} id_ip;
100 		uint32_t id_mask;
101 		char	id_data[1];
102 	} icmp_dun;
103 #define	icmp_otime	icmp_dun.id_ts.its_otime
104 #define	icmp_rtime	icmp_dun.id_ts.its_rtime
105 #define	icmp_ttime	icmp_dun.id_ts.its_ttime
106 #define	icmp_ip		icmp_dun.id_ip.idi_ip
107 #define	icmp_mask	icmp_dun.id_mask
108 #define	icmp_data	icmp_dun.id_data
109 };
110 
111 /*
112  * Lower bounds on packet lengths for various types.
113  * For the error advice packets must first insure that the
114  * packet is large enough to contain the returned ip header.
115  * Only then can we do the check to see if 64 bits of packet
116  * data have been returned, since we need to check the returned
117  * ip header length.
118  */
119 #define	ICMP_MINLEN	8				/* abs minimum */
120 #define	ICMP_TSLEN	(8 + 3 * sizeof (n_time))	/* timestamp */
121 #define	ICMP_MASKLEN	12				/* address mask */
122 #define	ICMP_ADVLENMIN	(8 + sizeof (struct ip) + 8)	/* min */
123 #define	ICMP_ADVLEN(p)	(8 + ((p)->icmp_ip.ip_hl << 2) + 8)
124 	/* N.B.: must separately check that ip_hl >= 5 */
125 
126 /*
127  * Definition of type and code field values.
128  */
129 #define	ICMP_ECHOREPLY		0		/* echo reply */
130 #define	ICMP_UNREACH		3		/* dest unreachable, codes: */
131 #define		ICMP_UNREACH_NET		0	/* bad net */
132 #define		ICMP_UNREACH_HOST		1	/* bad host */
133 #define		ICMP_UNREACH_PROTOCOL		2	/* bad protocol */
134 #define		ICMP_UNREACH_PORT		3	/* bad port */
135 #define		ICMP_UNREACH_NEEDFRAG		4	/* IP_DF caused drop */
136 #define		ICMP_UNREACH_SRCFAIL		5	/* src route failed */
137 #define		ICMP_UNREACH_NET_UNKNOWN	6	/* unknown net */
138 #define		ICMP_UNREACH_HOST_UNKNOWN	7	/* unknown host */
139 #define		ICMP_UNREACH_ISOLATED		8	/* src host isolated */
140 #define		ICMP_UNREACH_NET_PROHIB		9	/* prohibited access */
141 #define		ICMP_UNREACH_HOST_PROHIB	10	/* ditto */
142 #define		ICMP_UNREACH_TOSNET		11	/* bad tos for net */
143 #define		ICMP_UNREACH_TOSHOST		12	/* bad tos for host */
144 #define		ICMP_UNREACH_FILTER_PROHIB	13	/* prohibited access */
145 #define		ICMP_UNREACH_HOST_PRECEDENCE	14	/* pred violationn */
146 #define		ICMP_UNREACH_PRECEDENCE_CUTOFF	15	/* precedence cutoff */
147 #define	ICMP_SOURCEQUENCH	4		/* packet lost, slow down */
148 #define	ICMP_REDIRECT		5		/* shorter route, codes: */
149 #define		ICMP_REDIRECT_NET	0		/* for network */
150 #define		ICMP_REDIRECT_HOST	1		/* for host */
151 #define		ICMP_REDIRECT_TOSNET	2		/* for tos and net */
152 #define		ICMP_REDIRECT_TOSHOST	3		/* for tos and host */
153 #define	ICMP_ECHO		8		/* echo service */
154 #define	ICMP_ROUTERADVERT	9		/* router advertisement */
155 #define		ICMP_ROUTERADVERT_COMMON	0	/* common traffic */
156 #define		ICMP_ROUTERADVERT_NOCOMMON	16	/* no common traffic */
157 #define	ICMP_ROUTERSOLICIT	10		/* router solicitation */
158 #define	ICMP_TIMXCEED		11		/* time exceeded, code: */
159 #define		ICMP_TIMXCEED_INTRANS	0		/* ttl==0 in transit */
160 #define		ICMP_TIMXCEED_REASS	1		/* ttl==0 in reass */
161 #define	ICMP_PARAMPROB		12		/* ip header bad */
162 #define		ICMP_PARAMPROB_OPTABSENT	1	/* req. opt. absent */
163 #define		ICMP_PARAMPROB_BADLENGTH	2	/* Bad Length */
164 #define	ICMP_TSTAMP		13		/* timestamp request */
165 #define	ICMP_TSTAMPREPLY	14		/* timestamp reply */
166 #define	ICMP_IREQ		15		/* information request */
167 #define	ICMP_IREQREPLY		16		/* information reply */
168 #define	ICMP_MASKREQ		17		/* address mask request */
169 #define	ICMP_MASKREPLY		18		/* address mask reply */
170 
171 #define	ICMP_MAXTYPE		18
172 
173 #define	ICMP_INFOTYPE(type) \
174 	((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
175 	(type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
176 	(type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
177 	(type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
178 	(type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
179 
180 #ifdef	__cplusplus
181 }
182 #endif
183 
184 #endif	/* _NETINET_IP_ICMP_H */
185