xref: /netbsd-src/sys/netinet/ip_icmp.h (revision cda4f8f6ee55684e8d311b86c99ea59191e6b74f)
1 /*
2  * Copyright (c) 1982, 1986 Regents of the University of California.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	from: @(#)ip_icmp.h	7.5 (Berkeley) 6/28/90
34  *	$Id: ip_icmp.h,v 1.3 1993/05/20 03:50:22 cgd Exp $
35  */
36 
37 #ifndef _NETINET_IP_ICMP_H_
38 #define _NETINET_IP_ICMP_H_
39 
40 /*
41  * Interface Control Message Protocol Definitions.
42  * Per RFC 792, September 1981.
43  */
44 
45 /*
46  * Structure of an icmp header.
47  */
48 struct icmp {
49 	u_char	icmp_type;		/* type of message, see below */
50 	u_char	icmp_code;		/* type sub code */
51 	u_short	icmp_cksum;		/* ones complement cksum of struct */
52 	union {
53 		u_char ih_pptr;			/* ICMP_PARAMPROB */
54 		struct in_addr ih_gwaddr;	/* ICMP_REDIRECT */
55 		struct ih_idseq {
56 			n_short	icd_id;
57 			n_short	icd_seq;
58 		} ih_idseq;
59 		int ih_void;
60 	} icmp_hun;
61 #define	icmp_pptr	icmp_hun.ih_pptr
62 #define	icmp_gwaddr	icmp_hun.ih_gwaddr
63 #define	icmp_id		icmp_hun.ih_idseq.icd_id
64 #define	icmp_seq	icmp_hun.ih_idseq.icd_seq
65 #define	icmp_void	icmp_hun.ih_void
66 	union {
67 		struct id_ts {
68 			n_time its_otime;
69 			n_time its_rtime;
70 			n_time its_ttime;
71 		} id_ts;
72 		struct id_ip  {
73 			struct ip idi_ip;
74 			/* options and then 64 bits of data */
75 		} id_ip;
76 		u_long	id_mask;
77 		char	id_data[1];
78 	} icmp_dun;
79 #define	icmp_otime	icmp_dun.id_ts.its_otime
80 #define	icmp_rtime	icmp_dun.id_ts.its_rtime
81 #define	icmp_ttime	icmp_dun.id_ts.its_ttime
82 #define	icmp_ip		icmp_dun.id_ip.idi_ip
83 #define	icmp_mask	icmp_dun.id_mask
84 #define	icmp_data	icmp_dun.id_data
85 };
86 
87 /*
88  * Lower bounds on packet lengths for various types.
89  * For the error advice packets must first insure that the
90  * packet is large enought to contain the returned ip header.
91  * Only then can we do the check to see if 64 bits of packet
92  * data have been returned, since we need to check the returned
93  * ip header length.
94  */
95 #define	ICMP_MINLEN	8				/* abs minimum */
96 #define	ICMP_TSLEN	(8 + 3 * sizeof (n_time))	/* timestamp */
97 #define	ICMP_MASKLEN	12				/* address mask */
98 #define	ICMP_ADVLENMIN	(8 + sizeof (struct ip) + 8)	/* min */
99 #define	ICMP_ADVLEN(p)	(8 + ((p)->icmp_ip.ip_hl << 2) + 8)
100 	/* N.B.: must separately check that ip_hl >= 5 */
101 
102 /*
103  * Definition of type and code field values.
104  */
105 #define	ICMP_ECHOREPLY		0		/* echo reply */
106 #define	ICMP_UNREACH		3		/* dest unreachable, codes: */
107 #define		ICMP_UNREACH_NET	0		/* bad net */
108 #define		ICMP_UNREACH_HOST	1		/* bad host */
109 #define		ICMP_UNREACH_PROTOCOL	2		/* bad protocol */
110 #define		ICMP_UNREACH_PORT	3		/* bad port */
111 #define		ICMP_UNREACH_NEEDFRAG	4		/* IP_DF caused drop */
112 #define		ICMP_UNREACH_SRCFAIL	5		/* src route failed */
113 #define	ICMP_SOURCEQUENCH	4		/* packet lost, slow down */
114 #define	ICMP_REDIRECT		5		/* shorter route, codes: */
115 #define		ICMP_REDIRECT_NET	0		/* for network */
116 #define		ICMP_REDIRECT_HOST	1		/* for host */
117 #define		ICMP_REDIRECT_TOSNET	2		/* for tos and net */
118 #define		ICMP_REDIRECT_TOSHOST	3		/* for tos and host */
119 #define	ICMP_ECHO		8		/* echo service */
120 #define	ICMP_TIMXCEED		11		/* time exceeded, code: */
121 #define		ICMP_TIMXCEED_INTRANS	0		/* ttl==0 in transit */
122 #define		ICMP_TIMXCEED_REASS	1		/* ttl==0 in reass */
123 #define	ICMP_PARAMPROB		12		/* ip header bad */
124 #define	ICMP_TSTAMP		13		/* timestamp request */
125 #define	ICMP_TSTAMPREPLY	14		/* timestamp reply */
126 #define	ICMP_IREQ		15		/* information request */
127 #define	ICMP_IREQREPLY		16		/* information reply */
128 #define	ICMP_MASKREQ		17		/* address mask request */
129 #define	ICMP_MASKREPLY		18		/* address mask reply */
130 
131 #define	ICMP_MAXTYPE		18
132 
133 #define	ICMP_INFOTYPE(type) \
134 	((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
135 	(type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
136 	(type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
137 	(type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
138 
139 #endif /* !_NETINET_IP_ICMP_H_ */
140