xref: /freebsd/sys/netinet/ip_icmp.h (revision b7a1a0a5ff8895e6a5c9404d02357ac9e2eb8091)
1 /*
2  * Copyright (c) 1982, 1986, 1993
3  *	The Regents of the University of California.  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  *	@(#)ip_icmp.h	8.1 (Berkeley) 6/10/93
34  * $Id: ip_icmp.h,v 1.2 1994/08/02 07:48:35 davidg 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 
61 		/* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
62 		struct ih_pmtu {
63 			n_short ipm_void;
64 			n_short ipm_nextmtu;
65 		} ih_pmtu;
66 	} icmp_hun;
67 #define	icmp_pptr	icmp_hun.ih_pptr
68 #define	icmp_gwaddr	icmp_hun.ih_gwaddr
69 #define	icmp_id		icmp_hun.ih_idseq.icd_id
70 #define	icmp_seq	icmp_hun.ih_idseq.icd_seq
71 #define	icmp_void	icmp_hun.ih_void
72 #define	icmp_pmvoid	icmp_hun.ih_pmtu.ipm_void
73 #define	icmp_nextmtu	icmp_hun.ih_pmtu.ipm_nextmtu
74 	union {
75 		struct id_ts {
76 			n_time its_otime;
77 			n_time its_rtime;
78 			n_time its_ttime;
79 		} id_ts;
80 		struct id_ip  {
81 			struct ip idi_ip;
82 			/* options and then 64 bits of data */
83 		} id_ip;
84 		u_long	id_mask;
85 		char	id_data[1];
86 	} icmp_dun;
87 #define	icmp_otime	icmp_dun.id_ts.its_otime
88 #define	icmp_rtime	icmp_dun.id_ts.its_rtime
89 #define	icmp_ttime	icmp_dun.id_ts.its_ttime
90 #define	icmp_ip		icmp_dun.id_ip.idi_ip
91 #define	icmp_mask	icmp_dun.id_mask
92 #define	icmp_data	icmp_dun.id_data
93 };
94 
95 /*
96  * Lower bounds on packet lengths for various types.
97  * For the error advice packets must first insure that the
98  * packet is large enought to contain the returned ip header.
99  * Only then can we do the check to see if 64 bits of packet
100  * data have been returned, since we need to check the returned
101  * ip header length.
102  */
103 #define	ICMP_MINLEN	8				/* abs minimum */
104 #define	ICMP_TSLEN	(8 + 3 * sizeof (n_time))	/* timestamp */
105 #define	ICMP_MASKLEN	12				/* address mask */
106 #define	ICMP_ADVLENMIN	(8 + sizeof (struct ip) + 8)	/* min */
107 #define	ICMP_ADVLEN(p)	(8 + ((p)->icmp_ip.ip_hl << 2) + 8)
108 	/* N.B.: must separately check that ip_hl >= 5 */
109 
110 /*
111  * Definition of type and code field values.
112  */
113 #define	ICMP_ECHOREPLY		0		/* echo reply */
114 #define	ICMP_UNREACH		3		/* dest unreachable, codes: */
115 #define		ICMP_UNREACH_NET	0		/* bad net */
116 #define		ICMP_UNREACH_HOST	1		/* bad host */
117 #define		ICMP_UNREACH_PROTOCOL	2		/* bad protocol */
118 #define		ICMP_UNREACH_PORT	3		/* bad port */
119 #define		ICMP_UNREACH_NEEDFRAG	4		/* IP_DF caused drop */
120 #define		ICMP_UNREACH_SRCFAIL	5		/* src route failed */
121 #define		ICMP_UNREACH_NET_UNKNOWN 6		/* unknown net */
122 #define		ICMP_UNREACH_HOST_UNKNOWN 7		/* unknown host */
123 #define		ICMP_UNREACH_ISOLATED	8		/* src host isolated */
124 #define		ICMP_UNREACH_NET_PROHIB	9		/* prohibited access */
125 #define		ICMP_UNREACH_HOST_PROHIB 10		/* ditto */
126 #define		ICMP_UNREACH_TOSNET	11		/* bad tos for net */
127 #define		ICMP_UNREACH_TOSHOST	12		/* bad tos for host */
128 #define	ICMP_SOURCEQUENCH	4		/* packet lost, slow down */
129 #define	ICMP_REDIRECT		5		/* shorter route, codes: */
130 #define		ICMP_REDIRECT_NET	0		/* for network */
131 #define		ICMP_REDIRECT_HOST	1		/* for host */
132 #define		ICMP_REDIRECT_TOSNET	2		/* for tos and net */
133 #define		ICMP_REDIRECT_TOSHOST	3		/* for tos and host */
134 #define	ICMP_ECHO		8		/* echo service */
135 #define	ICMP_ROUTERADVERT	9		/* router advertisement */
136 #define	ICMP_ROUTERSOLICIT	10		/* router solicitation */
137 #define	ICMP_TIMXCEED		11		/* time exceeded, code: */
138 #define		ICMP_TIMXCEED_INTRANS	0		/* ttl==0 in transit */
139 #define		ICMP_TIMXCEED_REASS	1		/* ttl==0 in reass */
140 #define	ICMP_PARAMPROB		12		/* ip header bad */
141 #define		ICMP_PARAMPROB_OPTABSENT 1		/* req. opt. absent */
142 #define	ICMP_TSTAMP		13		/* timestamp request */
143 #define	ICMP_TSTAMPREPLY	14		/* timestamp reply */
144 #define	ICMP_IREQ		15		/* information request */
145 #define	ICMP_IREQREPLY		16		/* information reply */
146 #define	ICMP_MASKREQ		17		/* address mask request */
147 #define	ICMP_MASKREPLY		18		/* address mask reply */
148 
149 #define	ICMP_MAXTYPE		18
150 
151 #define	ICMP_INFOTYPE(type) \
152 	((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
153 	(type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
154 	(type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
155 	(type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
156 	(type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
157 
158 #ifdef KERNEL
159 void	icmp_error __P((struct mbuf *, int, int, n_long, struct ifnet *));
160 void	icmp_input __P((struct mbuf *, int));
161 void	icmp_reflect __P((struct mbuf *));
162 void	icmp_send __P((struct mbuf *, struct mbuf *));
163 int	icmp_sysctl __P((int *, u_int, void *, size_t *, void *, size_t));
164 #endif
165 
166 #endif
167