xref: /netbsd-src/sys/netinet/ip_icmp.h (revision c2f76ff004a2cb67efe5b12d97bd3ef7fe89e18d)
1 /*	$NetBSD: ip_icmp.h,v 1.26 2010/06/26 14:24:29 kefren Exp $	*/
2 
3 /*
4  * Copyright (c) 1982, 1986, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)ip_icmp.h	8.1 (Berkeley) 6/10/93
32  */
33 
34 #ifndef _NETINET_IP_ICMP_H_
35 #define _NETINET_IP_ICMP_H_
36 
37 
38 /*
39  * Interface Control Message Protocol Definitions.
40  * Per RFC 792, September 1981.
41  */
42 
43 /*
44  * Internal of an ICMP Router Advertisement
45  */
46 struct icmp_ra_addr {
47 	u_int32_t ira_addr;
48 	u_int32_t ira_preference;
49 } __packed;
50 
51 /*
52  * Structure of an icmp header.
53  */
54 struct icmp {
55 	u_int8_t  icmp_type;		/* type of message, see below */
56 	u_int8_t  icmp_code;		/* type sub code */
57 	u_int16_t icmp_cksum;		/* ones complement cksum of struct */
58 	union {
59 		u_int8_t  ih_pptr;		/* ICMP_PARAMPROB */
60 		struct in_addr ih_gwaddr;	/* ICMP_REDIRECT */
61 		struct ih_idseq {
62 			  n_short icd_id;
63 			  n_short icd_seq;
64 		} ih_idseq __packed;
65 		int32_t   ih_void;
66 
67 		/* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
68 		struct ih_pmtu {
69 			  n_short ipm_void;
70 			  n_short ipm_nextmtu;
71 		} ih_pmtu __packed;
72 		struct ih_rtradv {
73 			u_int8_t irt_num_addrs;
74 			u_int8_t irt_wpa;
75 			u_int16_t irt_lifetime;
76 		} ih_rtradv __packed;
77 	} icmp_hun /* XXX __packed ??? */;
78 #define	icmp_pptr	  icmp_hun.ih_pptr
79 #define	icmp_gwaddr	  icmp_hun.ih_gwaddr
80 #define	icmp_id		  icmp_hun.ih_idseq.icd_id
81 #define	icmp_seq	  icmp_hun.ih_idseq.icd_seq
82 #define	icmp_void	  icmp_hun.ih_void
83 #define	icmp_pmvoid	  icmp_hun.ih_pmtu.ipm_void
84 #define	icmp_nextmtu	  icmp_hun.ih_pmtu.ipm_nextmtu
85 #define icmp_num_addrs    icmp_hun.ih_rtradv.irt_num_addrs
86 #define icmp_wpa	  icmp_hun.ih_rtradv.irt_wpa
87 #define icmp_lifetime	  icmp_hun.ih_rtradv.irt_lifetime
88 	union {
89 		struct id_ts {
90 			  n_time its_otime;
91 			  n_time its_rtime;
92 			  n_time its_ttime;
93 		} id_ts __packed;
94 		struct id_ip  {
95 			  struct ip idi_ip;
96 			  /* options and then 64 bits of data */
97 		} id_ip /* XXX: __packed ??? */;
98 		struct icmp_ra_addr id_radv;
99 		u_int32_t id_mask;
100 		int8_t	  id_data[1];
101 	} icmp_dun /* XXX __packed ??? */;
102 #define	icmp_otime	  icmp_dun.id_ts.its_otime
103 #define	icmp_rtime	  icmp_dun.id_ts.its_rtime
104 #define	icmp_ttime	  icmp_dun.id_ts.its_ttime
105 #define	icmp_ip		  icmp_dun.id_ip.idi_ip
106 #define icmp_radv	  icmp_dun.id_mask
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 enought 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_ADMIN_PROHIBIT 13		/* communication
145 							   administratively
146 							   prohibited */
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_ROUTERSOLICIT	10		/* router solicitation */
156 #define	ICMP_TIMXCEED		11		/* time exceeded, code: */
157 #define		ICMP_TIMXCEED_INTRANS	0		/* ttl==0 in transit */
158 #define		ICMP_TIMXCEED_REASS	1		/* ttl==0 in reass */
159 #define	ICMP_PARAMPROB		12		/* ip header bad */
160 #define		ICMP_PARAMPROB_OPTABSENT 1		/* req. opt. absent */
161 #define	ICMP_TSTAMP		13		/* timestamp request */
162 #define	ICMP_TSTAMPREPLY	14		/* timestamp reply */
163 #define	ICMP_IREQ		15		/* information request */
164 #define	ICMP_IREQREPLY		16		/* information reply */
165 #define	ICMP_MASKREQ		17		/* address mask request */
166 #define	ICMP_MASKREPLY		18		/* address mask reply */
167 
168 #define	ICMP_MAXTYPE		18
169 
170 #define	ICMP_INFOTYPE(type) \
171 	((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
172 	(type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
173 	(type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
174 	(type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
175 	(type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
176 
177 #ifdef _KERNEL
178 void	icmp_error(struct mbuf *, int, int, n_long, int);
179 void	icmp_mtudisc(struct icmp *, struct in_addr);
180 void	icmp_input(struct mbuf *, ...);
181 void	icmp_init(void);
182 void	icmp_reflect(struct mbuf *);
183 void	icmp_send(struct mbuf *, struct mbuf *);
184 int	icmp_sysctl(int *, u_int, void *, size_t *, void *, size_t);
185 
186 void	icmp_mtudisc_callback_register(void (*)(struct in_addr));
187 int	icmp_ratelimit(const struct in_addr *, const int, const int);
188 #endif
189 
190 
191 #endif /* !_NETINET_IP_ICMP_H_ */
192