[unix-history] / sys / netinet / ip_icmp.h

/*
 * Copyright (c) 1982, 1986 Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	from: @(#)ip_icmp.h	7.5 (Berkeley) 6/28/90
 *	$Id$
 */

/*
 * Interface Control Message Protocol Definitions.
 * Per RFC 792, September 1981.
 */

/*
 * Structure of an icmp header.
 */
struct icmp {
	u_char	icmp_type;		/* type of message, see below */
	u_char	icmp_code;		/* type sub code */
	u_short	icmp_cksum;		/* ones complement cksum of struct */
	union {
		u_char ih_pptr;			/* ICMP_PARAMPROB */
		struct in_addr ih_gwaddr;	/* ICMP_REDIRECT */
		struct ih_idseq {
			n_short	icd_id;
			n_short	icd_seq;
		} ih_idseq;
		int ih_void;
	} icmp_hun;
#define	icmp_pptr	icmp_hun.ih_pptr
#define	icmp_gwaddr	icmp_hun.ih_gwaddr
#define	icmp_id		icmp_hun.ih_idseq.icd_id
#define	icmp_seq	icmp_hun.ih_idseq.icd_seq
#define	icmp_void	icmp_hun.ih_void
	union {
		struct id_ts {
			n_time its_otime;
			n_time its_rtime;
			n_time its_ttime;
		} id_ts;
		struct id_ip  {
			struct ip idi_ip;
			/* options and then 64 bits of data */
		} id_ip;
		u_long	id_mask;
		char	id_data[1];
	} icmp_dun;
#define	icmp_otime	icmp_dun.id_ts.its_otime
#define	icmp_rtime	icmp_dun.id_ts.its_rtime
#define	icmp_ttime	icmp_dun.id_ts.its_ttime
#define	icmp_ip		icmp_dun.id_ip.idi_ip
#define	icmp_mask	icmp_dun.id_mask
#define	icmp_data	icmp_dun.id_data
};

/*
 * Lower bounds on packet lengths for various types.
 * For the error advice packets must first insure that the
 * packet is large enought to contain the returned ip header.
 * Only then can we do the check to see if 64 bits of packet
 * data have been returned, since we need to check the returned
 * ip header length.
 */
#define	ICMP_MINLEN	8				/* abs minimum */
#define	ICMP_TSLEN	(8 + 3 * sizeof (n_time))	/* timestamp */
#define	ICMP_MASKLEN	12				/* address mask */
#define	ICMP_ADVLENMIN	(8 + sizeof (struct ip) + 8)	/* min */
#define	ICMP_ADVLEN(p)	(8 + ((p)->icmp_ip.ip_hl << 2) + 8)
	/* N.B.: must separately check that ip_hl >= 5 */

/*
 * Definition of type and code field values.
 */
#define	ICMP_ECHOREPLY		0		/* echo reply */
#define	ICMP_UNREACH		3		/* dest unreachable, codes: */
#define		ICMP_UNREACH_NET	0		/* bad net */
#define		ICMP_UNREACH_HOST	1		/* bad host */
#define		ICMP_UNREACH_PROTOCOL	2		/* bad protocol */
#define		ICMP_UNREACH_PORT	3		/* bad port */
#define		ICMP_UNREACH_NEEDFRAG	4		/* IP_DF caused drop */
#define		ICMP_UNREACH_SRCFAIL	5		/* src route failed */
#define	ICMP_SOURCEQUENCH	4		/* packet lost, slow down */
#define	ICMP_REDIRECT		5		/* shorter route, codes: */
#define		ICMP_REDIRECT_NET	0		/* for network */
#define		ICMP_REDIRECT_HOST	1		/* for host */
#define		ICMP_REDIRECT_TOSNET	2		/* for tos and net */
#define		ICMP_REDIRECT_TOSHOST	3		/* for tos and host */
#define	ICMP_ECHO		8		/* echo service */
#define	ICMP_TIMXCEED		11		/* time exceeded, code: */
#define		ICMP_TIMXCEED_INTRANS	0		/* ttl==0 in transit */
#define		ICMP_TIMXCEED_REASS	1		/* ttl==0 in reass */
#define	ICMP_PARAMPROB		12		/* ip header bad */
#define	ICMP_TSTAMP		13		/* timestamp request */
#define	ICMP_TSTAMPREPLY	14		/* timestamp reply */
#define	ICMP_IREQ		15		/* information request */
#define	ICMP_IREQREPLY		16		/* information reply */
#define	ICMP_MASKREQ		17		/* address mask request */
#define	ICMP_MASKREPLY		18		/* address mask reply */

#define	ICMP_MAXTYPE		18

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