ip_icmp.h revision 1.2 
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 *	@(#)ip_icmp.h	7.5 (Berkeley) 6/28/90
34 */
35
36#ifndef _NETINET_IP_ICMP_H_
37#define _NETINET_IP_ICMP_H_
38
39/*
40 * Interface Control Message Protocol Definitions.
41 * Per RFC 792, September 1981.
42 */
43
44/*
45 * Structure of an icmp header.
46 */
47struct icmp {
48	u_char	icmp_type;		/* type of message, see below */
49	u_char	icmp_code;		/* type sub code */
50	u_short	icmp_cksum;		/* ones complement cksum of struct */
51	union {
52		u_char ih_pptr;			/* ICMP_PARAMPROB */
53		struct in_addr ih_gwaddr;	/* ICMP_REDIRECT */
54		struct ih_idseq {
55			n_short	icd_id;
56			n_short	icd_seq;
57		} ih_idseq;
58		int ih_void;
59	} icmp_hun;
60#define	icmp_pptr	icmp_hun.ih_pptr
61#define	icmp_gwaddr	icmp_hun.ih_gwaddr
62#define	icmp_id		icmp_hun.ih_idseq.icd_id
63#define	icmp_seq	icmp_hun.ih_idseq.icd_seq
64#define	icmp_void	icmp_hun.ih_void
65	union {
66		struct id_ts {
67			n_time its_otime;
68			n_time its_rtime;
69			n_time its_ttime;
70		} id_ts;
71		struct id_ip  {
72			struct ip idi_ip;
73			/* options and then 64 bits of data */
74		} id_ip;
75		u_long	id_mask;
76		char	id_data[1];
77	} icmp_dun;
78#define	icmp_otime	icmp_dun.id_ts.its_otime
79#define	icmp_rtime	icmp_dun.id_ts.its_rtime
80#define	icmp_ttime	icmp_dun.id_ts.its_ttime
81#define	icmp_ip		icmp_dun.id_ip.idi_ip
82#define	icmp_mask	icmp_dun.id_mask
83#define	icmp_data	icmp_dun.id_data
84};
85
86/*
87 * Lower bounds on packet lengths for various types.
88 * For the error advice packets must first insure that the
89 * packet is large enought to contain the returned ip header.
90 * Only then can we do the check to see if 64 bits of packet
91 * data have been returned, since we need to check the returned
92 * ip header length.
93 */
94#define	ICMP_MINLEN	8				/* abs minimum */
95#define	ICMP_TSLEN	(8 + 3 * sizeof (n_time))	/* timestamp */
96#define	ICMP_MASKLEN	12				/* address mask */
97#define	ICMP_ADVLENMIN	(8 + sizeof (struct ip) + 8)	/* min */
98#define	ICMP_ADVLEN(p)	(8 + ((p)->icmp_ip.ip_hl << 2) + 8)
99	/* N.B.: must separately check that ip_hl >= 5 */
100
101/*
102 * Definition of type and code field values.
103 */
104#define	ICMP_ECHOREPLY		0		/* echo reply */
105#define	ICMP_UNREACH		3		/* dest unreachable, codes: */
106#define		ICMP_UNREACH_NET	0		/* bad net */
107#define		ICMP_UNREACH_HOST	1		/* bad host */
108#define		ICMP_UNREACH_PROTOCOL	2		/* bad protocol */
109#define		ICMP_UNREACH_PORT	3		/* bad port */
110#define		ICMP_UNREACH_NEEDFRAG	4		/* IP_DF caused drop */
111#define		ICMP_UNREACH_SRCFAIL	5		/* src route failed */
112#define	ICMP_SOURCEQUENCH	4		/* packet lost, slow down */
113#define	ICMP_REDIRECT		5		/* shorter route, codes: */
114#define		ICMP_REDIRECT_NET	0		/* for network */
115#define		ICMP_REDIRECT_HOST	1		/* for host */
116#define		ICMP_REDIRECT_TOSNET	2		/* for tos and net */
117#define		ICMP_REDIRECT_TOSHOST	3		/* for tos and host */
118#define	ICMP_ECHO		8		/* echo service */
119#define	ICMP_TIMXCEED		11		/* time exceeded, code: */
120#define		ICMP_TIMXCEED_INTRANS	0		/* ttl==0 in transit */
121#define		ICMP_TIMXCEED_REASS	1		/* ttl==0 in reass */
122#define	ICMP_PARAMPROB		12		/* ip header bad */
123#define	ICMP_TSTAMP		13		/* timestamp request */
124#define	ICMP_TSTAMPREPLY	14		/* timestamp reply */
125#define	ICMP_IREQ		15		/* information request */
126#define	ICMP_IREQREPLY		16		/* information reply */
127#define	ICMP_MASKREQ		17		/* address mask request */
128#define	ICMP_MASKREPLY		18		/* address mask reply */
129
130#define	ICMP_MAXTYPE		18
131
132#define	ICMP_INFOTYPE(type) \
133	((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
134	(type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
135	(type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
136	(type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
137
138#endif /* !_NETINET_IP_ICMP_H_ */
139