[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: ip_icmp.h,v 1.3 1993/11/07 17:47:57 wollman Exp $
 */

#ifndef _NETINET_IP_ICMP_H_
#define _NETINET_IP_ICMP_H_ 1

/*
 * 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;
		struct ih_mtu {
			n_short imt_unused;
			n_short imt_nhmtu;
		} ih_mtu;
		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
#define icmp_mtu	icmp_hun.ih_mtu.imt_nhmtu
#define icmp_mtuvoid	icmp_hun.ih_mtu.imt_unused
	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_UNREACH_NETUNKNOWN	6		/* dest net unknown */
#define		ICMP_UNREACH_HSTUNKNOWN 7		/* dst host unknown */
#define		ICMP_UNREACH_ISOLATED	8		/* src host isolated*/
/* next two are for administratively prohibited */
#define		ICMP_UNREACH_NETADMIN	9		/* dest net */
#define		ICMP_UNREACH_HOSTADMIN	10		/* dest host */
/* next two are for TOS unreachables */
#define		ICMP_UNREACH_TOSNET	11		/* dest net+tos */
#define		ICMP_UNREACH_TOSHOST	12		/* dest host+tos */
#define		ICMP_UNREACH_MAXCODE	12

#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_REDIRECT_MAXCODE	3

#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_TIMXCEED_MAXCODE	1

#define	ICMP_PARAMPROB		12		/* ip header bad */
#define		ICMP_PARAMPROB_GENERAL	0		/* generic problems */
#define		ICMP_PARAMPROB_REQDOPT	1		/* option  misssing */
#define		ICMP_PARAMPROB_MAXCODE	1

#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)

#ifdef KERNEL
struct mbuf;
extern void icmp_error(struct mbuf *, int, int, struct in_addr, int);
extern void icmp_input(struct mbuf *, int);
n_time iptime(void);
#endif

#endif /* _NETINET_IP_ICMP_H_ */
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	*
38e82238	33	* from: @(#)ip_icmp.h 7.5 (Berkeley) 6/28/90
2cb63509	34	* $Id: ip_icmp.h,v 1.3 1993/11/07 17:47:57 wollman Exp $
15637ed4 RG	35	*/
15637ed4 RG	36
8ace4366 GW	37	#ifndef _NETINET_IP_ICMP_H_
	38	#define _NETINET_IP_ICMP_H_ 1
	39
15637ed4 RG	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;
2cb63509 GW	59	struct ih_mtu {
	60	n_short imt_unused;
	61	n_short imt_nhmtu;
	62	} ih_mtu;
15637ed4 RG	63	int ih_void;
	64	} icmp_hun;
	65	#define icmp_pptr icmp_hun.ih_pptr
	66	#define icmp_gwaddr icmp_hun.ih_gwaddr
	67	#define icmp_id icmp_hun.ih_idseq.icd_id
	68	#define icmp_seq icmp_hun.ih_idseq.icd_seq
	69	#define icmp_void icmp_hun.ih_void
2cb63509 GW	70	#define icmp_mtu icmp_hun.ih_mtu.imt_nhmtu
2cb63509 GW	71	#define icmp_mtuvoid icmp_hun.ih_mtu.imt_unused
15637ed4 RG	72	union {
	73	struct id_ts {
	74	n_time its_otime;
	75	n_time its_rtime;
	76	n_time its_ttime;
	77	} id_ts;
	78	struct id_ip {
	79	struct ip idi_ip;
	80	/* options and then 64 bits of data */
	81	} id_ip;
	82	u_long id_mask;
	83	char id_data[1];
	84	} icmp_dun;
	85	#define icmp_otime icmp_dun.id_ts.its_otime
	86	#define icmp_rtime icmp_dun.id_ts.its_rtime
	87	#define icmp_ttime icmp_dun.id_ts.its_ttime
	88	#define icmp_ip icmp_dun.id_ip.idi_ip
	89	#define icmp_mask icmp_dun.id_mask
	90	#define icmp_data icmp_dun.id_data
	91	};
	92
	93	/*
	94	* Lower bounds on packet lengths for various types.
	95	* For the error advice packets must first insure that the
	96	* packet is large enought to contain the returned ip header.
	97	* Only then can we do the check to see if 64 bits of packet
	98	* data have been returned, since we need to check the returned
	99	* ip header length.
	100	*/
	101	#define ICMP_MINLEN 8 /* abs minimum */
	102	#define ICMP_TSLEN (8 + 3 * sizeof (n_time)) /* timestamp */
	103	#define ICMP_MASKLEN 12 /* address mask */
	104	#define ICMP_ADVLENMIN (8 + sizeof (struct ip) + 8) /* min */
	105	#define ICMP_ADVLEN(p) (8 + ((p)->icmp_ip.ip_hl << 2) + 8)
	106	/* N.B.: must separately check that ip_hl >= 5 */
	107
	108	/*
	109	* Definition of type and code field values.
	110	*/
	111	#define ICMP_ECHOREPLY 0 /* echo reply */
	112	#define ICMP_UNREACH 3 /* dest unreachable, codes: */
	113	#define ICMP_UNREACH_NET 0 /* bad net */
	114	#define ICMP_UNREACH_HOST 1 /* bad host */
	115	#define ICMP_UNREACH_PROTOCOL 2 /* bad protocol */
	116	#define ICMP_UNREACH_PORT 3 /* bad port */
	117	#define ICMP_UNREACH_NEEDFRAG 4 /* IP_DF caused drop */
	118	#define ICMP_UNREACH_SRCFAIL 5 /* src route failed */
2cb63509 GW	119	#define ICMP_UNREACH_NETUNKNOWN 6 /* dest net unknown */
	120	#define ICMP_UNREACH_HSTUNKNOWN 7 /* dst host unknown */
	121	#define ICMP_UNREACH_ISOLATED 8 /* src host isolated*/
	122	/* next two are for administratively prohibited */
	123	#define ICMP_UNREACH_NETADMIN 9 /* dest net */
	124	#define ICMP_UNREACH_HOSTADMIN 10 /* dest host */
	125	/* next two are for TOS unreachables */
	126	#define ICMP_UNREACH_TOSNET 11 /* dest net+tos */
	127	#define ICMP_UNREACH_TOSHOST 12 /* dest host+tos */
	128	#define ICMP_UNREACH_MAXCODE 12
	129
15637ed4	130	#define ICMP_SOURCEQUENCH 4 /* packet lost, slow down */
2cb63509	131
15637ed4 RG	132	#define ICMP_REDIRECT 5 /* shorter route, codes: */
	133	#define ICMP_REDIRECT_NET 0 /* for network */
	134	#define ICMP_REDIRECT_HOST 1 /* for host */
	135	#define ICMP_REDIRECT_TOSNET 2 /* for tos and net */
	136	#define ICMP_REDIRECT_TOSHOST 3 /* for tos and host */
2cb63509 GW	137	#define ICMP_REDIRECT_MAXCODE 3
2cb63509 GW	138
15637ed4	139	#define ICMP_ECHO 8 /* echo service */
2cb63509	140
15637ed4 RG	141	#define ICMP_TIMXCEED 11 /* time exceeded, code: */
	142	#define ICMP_TIMXCEED_INTRANS 0 /* ttl==0 in transit */
	143	#define ICMP_TIMXCEED_REASS 1 /* ttl==0 in reass */
2cb63509 GW	144	#define ICMP_TIMXCEED_MAXCODE 1
2cb63509 GW	145
15637ed4	146	#define ICMP_PARAMPROB 12 /* ip header bad */
2cb63509 GW	147	#define ICMP_PARAMPROB_GENERAL 0 /* generic problems */
	148	#define ICMP_PARAMPROB_REQDOPT 1 /* option misssing */
	149	#define ICMP_PARAMPROB_MAXCODE 1
	150
15637ed4 RG	151	#define ICMP_TSTAMP 13 /* timestamp request */
	152	#define ICMP_TSTAMPREPLY 14 /* timestamp reply */
	153	#define ICMP_IREQ 15 /* information request */
	154	#define ICMP_IREQREPLY 16 /* information reply */
	155	#define ICMP_MASKREQ 17 /* address mask request */
	156	#define ICMP_MASKREPLY 18 /* address mask reply */
	157
	158	#define ICMP_MAXTYPE 18
	159
	160	#define ICMP_INFOTYPE(type) \
	161	((type) == ICMP_ECHOREPLY \|\| (type) == ICMP_ECHO \|\| \
	162	(type) == ICMP_TSTAMP \|\| (type) == ICMP_TSTAMPREPLY \|\| \
	163	(type) == ICMP_IREQ \|\| (type) == ICMP_IREQREPLY \|\| \
	164	(type) == ICMP_MASKREQ \|\| (type) == ICMP_MASKREPLY)
2cb63509 GW	165
	166	#ifdef KERNEL
	167	struct mbuf;
	168	extern void icmp_error(struct mbuf *, int, int, struct in_addr, int);
	169	extern void icmp_input(struct mbuf *, int);
	170	n_time iptime(void);
	171	#endif
	172
8ace4366	173	#endif /* _NETINET_IP_ICMP_H_ */