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

/*
 * Copyright (c) 1982, 1986 Regents of the University of California.
 * All rights reserved.
 *
 * %sccs.include.redist.c%
 *
 *	@(#)ip_icmp.h	7.6 (Berkeley) %G%
 */

/*
 * 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_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
		struct ih_pmtu {
			n_short ipm_void;    
			n_short ipm_nextmtu;
		} ih_pmtu;
	} 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_pmvoid	icmp_hun.ih_pmtu.ipm_void
#define	icmp_nextmtu	icmp_hun.ih_pmtu.ipm_nextmtu
	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_NET_UNKNOWN 6		/* unknown net */
#define		ICMP_UNREACH_HOST_UNKNOWN 7		/* unknown host */
#define		ICMP_UNREACH_ISOLATED	8		/* src host isolated */
#define		ICMP_UNREACH_NET_PROHIB	9		/* prohibited access */
#define		ICMP_UNREACH_HOST_PROHIB 10		/* ditto */
#define		ICMP_UNREACH_TOSNET	11		/* bad tos for net */
#define		ICMP_UNREACH_TOSHOST	12		/* bad tos for host */
#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_ROUTERADVERT	9		/* router advertisement */
#define	ICMP_ROUTERSOLICIT	10		/* router solicitation */
#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_PARAMPROB_OPTABSENT 1		/* req. opt. absent */
#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_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
	(type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
	(type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
	(type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
Commit	Line	Data
8ae0e4b4	1	/*
0880b18e	2	* Copyright (c) 1982, 1986 Regents of the University of California.
2b6b6284	3	* All rights reserved.
8ae0e4b4	4	*
dbf0c423	5	* %sccs.include.redist.c%
2b6b6284	6	*
69d96ae2	7	* @(#)ip_icmp.h 7.6 (Berkeley) %G%
8ae0e4b4	8	*/
9fc9afc2 BJ	9
	10	/*
	11	* Interface Control Message Protocol Definitions.
	12	* Per RFC 792, September 1981.
	13	*/
	14
	15	/*
	16	* Structure of an icmp header.
	17	*/
	18	struct icmp {
	19	u_char icmp_type; /* type of message, see below */
	20	u_char icmp_code; /* type sub code */
	21	u_short icmp_cksum; /* ones complement cksum of struct */
	22	union {
	23	u_char ih_pptr; /* ICMP_PARAMPROB */
2b4b57cd	24	struct in_addr ih_gwaddr; /* ICMP_REDIRECT */
9fc9afc2 BJ	25	struct ih_idseq {
	26	n_short icd_id;
	27	n_short icd_seq;
	28	} ih_idseq;
72e4f44e	29	int ih_void;
69d96ae2 AC	30
	31	/* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
	32	struct ih_pmtu {
	33	n_short ipm_void;
	34	n_short ipm_nextmtu;
	35	} ih_pmtu;
9fc9afc2 BJ	36	} icmp_hun;
	37	#define icmp_pptr icmp_hun.ih_pptr
	38	#define icmp_gwaddr icmp_hun.ih_gwaddr
	39	#define icmp_id icmp_hun.ih_idseq.icd_id
	40	#define icmp_seq icmp_hun.ih_idseq.icd_seq
72e4f44e	41	#define icmp_void icmp_hun.ih_void
69d96ae2 AC	42	#define icmp_pmvoid icmp_hun.ih_pmtu.ipm_void
69d96ae2 AC	43	#define icmp_nextmtu icmp_hun.ih_pmtu.ipm_nextmtu
9fc9afc2 BJ	44	union {
	45	struct id_ts {
	46	n_time its_otime;
	47	n_time its_rtime;
	48	n_time its_ttime;
	49	} id_ts;
	50	struct id_ip {
	51	struct ip idi_ip;
	52	/* options and then 64 bits of data */
	53	} id_ip;
27b1d9f5	54	u_long id_mask;
676c9f56	55	char id_data[1];
9fc9afc2 BJ	56	} icmp_dun;
	57	#define icmp_otime icmp_dun.id_ts.its_otime
	58	#define icmp_rtime icmp_dun.id_ts.its_rtime
	59	#define icmp_ttime icmp_dun.id_ts.its_ttime
	60	#define icmp_ip icmp_dun.id_ip.idi_ip
27b1d9f5	61	#define icmp_mask icmp_dun.id_mask
676c9f56	62	#define icmp_data icmp_dun.id_data
9fc9afc2 BJ	63	};
	64
	65	/*
	66	* Lower bounds on packet lengths for various types.
	67	* For the error advice packets must first insure that the
	68	* packet is large enought to contain the returned ip header.
	69	* Only then can we do the check to see if 64 bits of packet
	70	* data have been returned, since we need to check the returned
	71	* ip header length.
	72	*/
	73	#define ICMP_MINLEN 8 /* abs minimum */
	74	#define ICMP_TSLEN (8 + 3 * sizeof (n_time)) /* timestamp */
27b1d9f5	75	#define ICMP_MASKLEN 12 /* address mask */
9fc9afc2	76	#define ICMP_ADVLENMIN (8 + sizeof (struct ip) + 8) /* min */
39674d5f	77	#define ICMP_ADVLEN(p) (8 + ((p)->icmp_ip.ip_hl << 2) + 8)
9fc9afc2 BJ	78	/* N.B.: must separately check that ip_hl >= 5 */
	79
	80	/*
	81	* Definition of type and code field values.
	82	*/
	83	#define ICMP_ECHOREPLY 0 /* echo reply */
	84	#define ICMP_UNREACH 3 /* dest unreachable, codes: */
	85	#define ICMP_UNREACH_NET 0 /* bad net */
	86	#define ICMP_UNREACH_HOST 1 /* bad host */
	87	#define ICMP_UNREACH_PROTOCOL 2 /* bad protocol */
	88	#define ICMP_UNREACH_PORT 3 /* bad port */
	89	#define ICMP_UNREACH_NEEDFRAG 4 /* IP_DF caused drop */
	90	#define ICMP_UNREACH_SRCFAIL 5 /* src route failed */
69d96ae2 AC	91	#define ICMP_UNREACH_NET_UNKNOWN 6 /* unknown net */
	92	#define ICMP_UNREACH_HOST_UNKNOWN 7 /* unknown host */
	93	#define ICMP_UNREACH_ISOLATED 8 /* src host isolated */
	94	#define ICMP_UNREACH_NET_PROHIB 9 /* prohibited access */
	95	#define ICMP_UNREACH_HOST_PROHIB 10 /* ditto */
	96	#define ICMP_UNREACH_TOSNET 11 /* bad tos for net */
	97	#define ICMP_UNREACH_TOSHOST 12 /* bad tos for host */
9fc9afc2 BJ	98	#define ICMP_SOURCEQUENCH 4 /* packet lost, slow down */
	99	#define ICMP_REDIRECT 5 /* shorter route, codes: */
	100	#define ICMP_REDIRECT_NET 0 /* for network */
	101	#define ICMP_REDIRECT_HOST 1 /* for host */
	102	#define ICMP_REDIRECT_TOSNET 2 /* for tos and net */
	103	#define ICMP_REDIRECT_TOSHOST 3 /* for tos and host */
	104	#define ICMP_ECHO 8 /* echo service */
69d96ae2 AC	105	#define ICMP_ROUTERADVERT 9 /* router advertisement */
69d96ae2 AC	106	#define ICMP_ROUTERSOLICIT 10 /* router solicitation */
9fc9afc2 BJ	107	#define ICMP_TIMXCEED 11 /* time exceeded, code: */
	108	#define ICMP_TIMXCEED_INTRANS 0 /* ttl==0 in transit */
	109	#define ICMP_TIMXCEED_REASS 1 /* ttl==0 in reass */
b454c3ea	110	#define ICMP_PARAMPROB 12 /* ip header bad */
69d96ae2	111	#define ICMP_PARAMPROB_OPTABSENT 1 /* req. opt. absent */
9fc9afc2 BJ	112	#define ICMP_TSTAMP 13 /* timestamp request */
	113	#define ICMP_TSTAMPREPLY 14 /* timestamp reply */
	114	#define ICMP_IREQ 15 /* information request */
	115	#define ICMP_IREQREPLY 16 /* information reply */
27b1d9f5 MK	116	#define ICMP_MASKREQ 17 /* address mask request */
	117	#define ICMP_MASKREPLY 18 /* address mask reply */
	118
	119	#define ICMP_MAXTYPE 18
f78fc6cc MK	120
	121	#define ICMP_INFOTYPE(type) \
	122	((type) == ICMP_ECHOREPLY \|\| (type) == ICMP_ECHO \|\| \
69d96ae2	123	(type) == ICMP_ROUTERADVERT \|\| (type) == ICMP_ROUTERSOLICIT \|\| \
f78fc6cc MK	124	(type) == ICMP_TSTAMP \|\| (type) == ICMP_TSTAMPREPLY \|\| \
	125	(type) == ICMP_IREQ \|\| (type) == ICMP_IREQREPLY \|\| \
	126	(type) == ICMP_MASKREQ \|\| (type) == ICMP_MASKREPLY)