ip_icmp.h revision 1.14
1/*	$NetBSD: ip_icmp.h,v 1.14 1999/11/20 00:37:59 thorpej 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. All advertising materials mentioning features or use of this software
16 *    must display the following acknowledgement:
17 *	This product includes software developed by the University of
18 *	California, Berkeley and its contributors.
19 * 4. Neither the name of the University nor the names of its contributors
20 *    may be used to endorse or promote products derived from this software
21 *    without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 *	@(#)ip_icmp.h	8.1 (Berkeley) 6/10/93
36 */
37
38#ifndef _NETINET_IP_ICMP_H_
39#define _NETINET_IP_ICMP_H_
40
41
42/*
43 * Interface Control Message Protocol Definitions.
44 * Per RFC 792, September 1981.
45 */
46
47/*
48 * Internal of an ICMP Router Advertisement
49 */
50struct icmp_ra_addr {
51	u_int32_t ira_addr;
52	u_int32_t ira_preference;
53} __attribute__((__packed__));
54
55/*
56 * Structure of an icmp header.
57 */
58struct icmp {
59	u_int8_t  icmp_type;		/* type of message, see below */
60	u_int8_t  icmp_code;		/* type sub code */
61	u_int16_t icmp_cksum;		/* ones complement cksum of struct */
62	union {
63		u_int8_t  ih_pptr;		/* ICMP_PARAMPROB */
64		struct in_addr ih_gwaddr;	/* ICMP_REDIRECT */
65		struct ih_idseq {
66			  n_short icd_id;
67			  n_short icd_seq;
68		} ih_idseq __attribute__((__packed__));
69		int32_t   ih_void;
70
71		/* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
72		struct ih_pmtu {
73			  n_short ipm_void;
74			  n_short ipm_nextmtu;
75		} ih_pmtu __attribute__((__packed__));
76		struct ih_rtradv {
77			u_int8_t irt_num_addrs;
78			u_int8_t irt_wpa;
79			u_int16_t irt_lifetime;
80		} ih_rtradv __attribute__((__packed__));
81	} icmp_hun /* XXX __attribute__((__packed__)) ??? */;
82#define	icmp_pptr	  icmp_hun.ih_pptr
83#define	icmp_gwaddr	  icmp_hun.ih_gwaddr
84#define	icmp_id		  icmp_hun.ih_idseq.icd_id
85#define	icmp_seq	  icmp_hun.ih_idseq.icd_seq
86#define	icmp_void	  icmp_hun.ih_void
87#define	icmp_pmvoid	  icmp_hun.ih_pmtu.ipm_void
88#define	icmp_nextmtu	  icmp_hun.ih_pmtu.ipm_nextmtu
89#define icmp_num_addrs    icmp_hun.ih_rtradv.irt_num_addrs
90#define icmp_wpa	  icmp_hun.ih_rtradv.irt_wpa
91#define icmp_lifetime	  icmp_hun.ih_rtradv.irt_lifetime
92	union {
93		struct id_ts {
94			  n_time its_otime;
95			  n_time its_rtime;
96			  n_time its_ttime;
97		} id_ts __attribute__((__packed__));
98		struct id_ip  {
99			  struct ip idi_ip;
100			  /* options and then 64 bits of data */
101		} id_ip __attribute__((__packed__));
102		struct icmp_ra_addr id_radv;
103		u_int32_t id_mask;
104		int8_t	  id_data[1];
105	} icmp_dun /* XXX __attribute__((__packed__)) ??? */;
106#define	icmp_otime	  icmp_dun.id_ts.its_otime
107#define	icmp_rtime	  icmp_dun.id_ts.its_rtime
108#define	icmp_ttime	  icmp_dun.id_ts.its_ttime
109#define	icmp_ip		  icmp_dun.id_ip.idi_ip
110#define icmp_radv	  icmp_dun.id_mask
111#define	icmp_mask	  icmp_dun.id_mask
112#define	icmp_data	  icmp_dun.id_data
113};
114
115/*
116 * Lower bounds on packet lengths for various types.
117 * For the error advice packets must first insure that the
118 * packet is large enought to contain the returned ip header.
119 * Only then can we do the check to see if 64 bits of packet
120 * data have been returned, since we need to check the returned
121 * ip header length.
122 */
123#define	ICMP_MINLEN	8				/* abs minimum */
124#define	ICMP_TSLEN	(8 + 3 * sizeof (n_time))	/* timestamp */
125#define	ICMP_MASKLEN	12				/* address mask */
126#define	ICMP_ADVLENMIN	(8 + sizeof (struct ip) + 8)	/* min */
127#define	ICMP_ADVLEN(p)	(8 + ((p)->icmp_ip.ip_hl << 2) + 8)
128	/* N.B.: must separately check that ip_hl >= 5 */
129
130/*
131 * Definition of type and code field values.
132 */
133#define	ICMP_ECHOREPLY		0		/* echo reply */
134#define	ICMP_UNREACH		3		/* dest unreachable, codes: */
135#define		ICMP_UNREACH_NET	0		/* bad net */
136#define		ICMP_UNREACH_HOST	1		/* bad host */
137#define		ICMP_UNREACH_PROTOCOL	2		/* bad protocol */
138#define		ICMP_UNREACH_PORT	3		/* bad port */
139#define		ICMP_UNREACH_NEEDFRAG	4		/* IP_DF caused drop */
140#define		ICMP_UNREACH_SRCFAIL	5		/* src route failed */
141#define		ICMP_UNREACH_NET_UNKNOWN 6		/* unknown net */
142#define		ICMP_UNREACH_HOST_UNKNOWN 7		/* unknown host */
143#define		ICMP_UNREACH_ISOLATED	8		/* src host isolated */
144#define		ICMP_UNREACH_NET_PROHIB	9		/* prohibited access */
145#define		ICMP_UNREACH_HOST_PROHIB 10		/* ditto */
146#define		ICMP_UNREACH_TOSNET	11		/* bad tos for net */
147#define		ICMP_UNREACH_TOSHOST	12		/* bad tos for host */
148#define		ICMP_UNREACH_ADMIN_PROHIBIT 13		/* communication
149							   administratively
150							   prohibited */
151#define	ICMP_SOURCEQUENCH	4		/* packet lost, slow down */
152#define	ICMP_REDIRECT		5		/* shorter route, codes: */
153#define		ICMP_REDIRECT_NET	0		/* for network */
154#define		ICMP_REDIRECT_HOST	1		/* for host */
155#define		ICMP_REDIRECT_TOSNET	2		/* for tos and net */
156#define		ICMP_REDIRECT_TOSHOST	3		/* for tos and host */
157#define	ICMP_ECHO		8		/* echo service */
158#define	ICMP_ROUTERADVERT	9		/* router advertisement */
159#define	ICMP_ROUTERSOLICIT	10		/* router solicitation */
160#define	ICMP_TIMXCEED		11		/* time exceeded, code: */
161#define		ICMP_TIMXCEED_INTRANS	0		/* ttl==0 in transit */
162#define		ICMP_TIMXCEED_REASS	1		/* ttl==0 in reass */
163#define	ICMP_PARAMPROB		12		/* ip header bad */
164#define		ICMP_PARAMPROB_OPTABSENT 1		/* req. opt. absent */
165#define	ICMP_TSTAMP		13		/* timestamp request */
166#define	ICMP_TSTAMPREPLY	14		/* timestamp reply */
167#define	ICMP_IREQ		15		/* information request */
168#define	ICMP_IREQREPLY		16		/* information reply */
169#define	ICMP_MASKREQ		17		/* address mask request */
170#define	ICMP_MASKREPLY		18		/* address mask reply */
171
172#define	ICMP_MAXTYPE		18
173
174#define	ICMP_INFOTYPE(type) \
175	((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
176	(type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
177	(type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
178	(type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
179	(type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
180
181#ifdef _KERNEL
182void	icmp_error __P((struct mbuf *, int, int, n_long, struct ifnet *));
183void	icmp_input __P((struct mbuf *, ...));
184void	icmp_reflect __P((struct mbuf *));
185void	icmp_send __P((struct mbuf *, struct mbuf *));
186int	icmp_sysctl __P((int *, u_int, void *, size_t *, void *, size_t));
187#endif
188
189
190#endif /* _NETINET_IP_ICMP_H_ */
191