Home | History | Annotate | Download | only in netinet
      1 /*
      2  * Copyright 1997-2002 Sun Microsystems, Inc.  All rights reserved.
      3  * Use is subject to license terms.
      4  */
      5 
      6 /*
      7  * Copyright (c) 1982, 1986, 1993
      8  *      The Regents of the University of California.  All rights reserved.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *      This product includes software developed by the University of
     21  *      California, Berkeley and its contributors.
     22  * 4. Neither the name of the University nor the names of its contributors
     23  *    may be used to endorse or promote products derived from this software
     24  *    without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     36  * SUCH DAMAGE.
     37  */
     38 
     39 /*
     40  * Interface Control Message Protocol Definitions.
     41  * Per RFC 792, September 1981.
     42  */
     43 
     44 #ifndef	_NETINET_IP_ICMP_H
     45 #define	_NETINET_IP_ICMP_H
     46 
     47 #pragma ident	"%Z%%M%	%I%	%E% SMI"
     48 /* ip_icmp.h 1.9 88/08/19 SMI; from UCB 7.3 12/7/87	*/
     49 
     50 #ifdef	__cplusplus
     51 extern "C" {
     52 #endif
     53 
     54 /*
     55  * Structure of an icmp header.
     56  */
     57 struct icmp {
     58 	uchar_t	icmp_type;		/* type of message, see below */
     59 	uchar_t	icmp_code;		/* type sub code */
     60 	uint16_t icmp_cksum;		/* ones complement cksum of struct */
     61 	union {
     62 		uchar_t ih_pptr;		/* ICMP_PARAMPROB */
     63 		struct in_addr ih_gwaddr;	/* ICMP_REDIRECT */
     64 		struct ih_idseq {
     65 			uint16_t icd_id;
     66 			uint16_t icd_seq;
     67 		} ih_idseq;
     68 		int ih_void;
     69 
     70 		/* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
     71 		struct ih_pmtu {
     72 			uint16_t ipm_void;
     73 			uint16_t ipm_nextmtu;
     74 		} ih_pmtu;
     75 
     76 		struct ih_rtradv {
     77 			uchar_t irt_num_addrs;
     78 			uchar_t irt_wpa;
     79 			uint16_t irt_lifetime;
     80 		} ih_rtradv;
     81 	} icmp_hun;
     82 #define	icmp_pptr	icmp_hun.ih_pptr
     83 #define	icmp_gwaddr	icmp_hun.ih_gwaddr
     84 #define	icmp_id		icmp_hun.ih_idseq.icd_id
     85 #define	icmp_seq	icmp_hun.ih_idseq.icd_seq
     86 #define	icmp_void	icmp_hun.ih_void
     87 #define	icmp_pmvoid	icmp_hun.ih_pmtu.ipm_void
     88 #define	icmp_nextmtu	icmp_hun.ih_pmtu.ipm_nextmtu
     89 	union {
     90 		struct id_ts {
     91 			n_time its_otime;
     92 			n_time its_rtime;
     93 			n_time its_ttime;
     94 		} id_ts;
     95 		struct id_ip  {
     96 			struct ip idi_ip;
     97 			/* options and then 64 bits of data */
     98 		} id_ip;
     99 		uint32_t id_mask;
    100 		char	id_data[1];
    101 	} icmp_dun;
    102 #define	icmp_otime	icmp_dun.id_ts.its_otime
    103 #define	icmp_rtime	icmp_dun.id_ts.its_rtime
    104 #define	icmp_ttime	icmp_dun.id_ts.its_ttime
    105 #define	icmp_ip		icmp_dun.id_ip.idi_ip
    106 #define	icmp_mask	icmp_dun.id_mask
    107 #define	icmp_data	icmp_dun.id_data
    108 };
    109 
    110 /*
    111  * Lower bounds on packet lengths for various types.
    112  * For the error advice packets must first insure that the
    113  * packet is large enough to contain the returned ip header.
    114  * Only then can we do the check to see if 64 bits of packet
    115  * data have been returned, since we need to check the returned
    116  * ip header length.
    117  */
    118 #define	ICMP_MINLEN	8				/* abs minimum */
    119 #define	ICMP_TSLEN	(8 + 3 * sizeof (n_time))	/* timestamp */
    120 #define	ICMP_MASKLEN	12				/* address mask */
    121 #define	ICMP_ADVLENMIN	(8 + sizeof (struct ip) + 8)	/* min */
    122 #define	ICMP_ADVLEN(p)	(8 + ((p)->icmp_ip.ip_hl << 2) + 8)
    123 	/* N.B.: must separately check that ip_hl >= 5 */
    124 
    125 /*
    126  * Definition of type and code field values.
    127  */
    128 #define	ICMP_ECHOREPLY		0		/* echo reply */
    129 #define	ICMP_UNREACH		3		/* dest unreachable, codes: */
    130 #define		ICMP_UNREACH_NET		0	/* bad net */
    131 #define		ICMP_UNREACH_HOST		1	/* bad host */
    132 #define		ICMP_UNREACH_PROTOCOL		2	/* bad protocol */
    133 #define		ICMP_UNREACH_PORT		3	/* bad port */
    134 #define		ICMP_UNREACH_NEEDFRAG		4	/* IP_DF caused drop */
    135 #define		ICMP_UNREACH_SRCFAIL		5	/* src route failed */
    136 #define		ICMP_UNREACH_NET_UNKNOWN	6	/* unknown net */
    137 #define		ICMP_UNREACH_HOST_UNKNOWN	7	/* unknown host */
    138 #define		ICMP_UNREACH_ISOLATED		8	/* src host isolated */
    139 #define		ICMP_UNREACH_NET_PROHIB		9	/* prohibited access */
    140 #define		ICMP_UNREACH_HOST_PROHIB	10	/* ditto */
    141 #define		ICMP_UNREACH_TOSNET		11	/* bad tos for net */
    142 #define		ICMP_UNREACH_TOSHOST		12	/* bad tos for host */
    143 #define		ICMP_UNREACH_FILTER_PROHIB	13	/* prohibited access */
    144 #define		ICMP_UNREACH_HOST_PRECEDENCE	14	/* pred violationn */
    145 #define		ICMP_UNREACH_PRECEDENCE_CUTOFF	15	/* precedence cutoff */
    146 #define	ICMP_SOURCEQUENCH	4		/* packet lost, slow down */
    147 #define	ICMP_REDIRECT		5		/* shorter route, codes: */
    148 #define		ICMP_REDIRECT_NET	0		/* for network */
    149 #define		ICMP_REDIRECT_HOST	1		/* for host */
    150 #define		ICMP_REDIRECT_TOSNET	2		/* for tos and net */
    151 #define		ICMP_REDIRECT_TOSHOST	3		/* for tos and host */
    152 #define	ICMP_ECHO		8		/* echo service */
    153 #define	ICMP_ROUTERADVERT	9		/* router advertisement */
    154 #define		ICMP_ROUTERADVERT_COMMON	0	/* common traffic */
    155 #define		ICMP_ROUTERADVERT_NOCOMMON	16	/* no common traffic */
    156 #define	ICMP_ROUTERSOLICIT	10		/* router solicitation */
    157 #define	ICMP_TIMXCEED		11		/* time exceeded, code: */
    158 #define		ICMP_TIMXCEED_INTRANS	0		/* ttl==0 in transit */
    159 #define		ICMP_TIMXCEED_REASS	1		/* ttl==0 in reass */
    160 #define	ICMP_PARAMPROB		12		/* ip header bad */
    161 #define		ICMP_PARAMPROB_OPTABSENT	1	/* req. opt. absent */
    162 #define		ICMP_PARAMPROB_BADLENGTH	2	/* Bad Length */
    163 #define	ICMP_TSTAMP		13		/* timestamp request */
    164 #define	ICMP_TSTAMPREPLY	14		/* timestamp reply */
    165 #define	ICMP_IREQ		15		/* information request */
    166 #define	ICMP_IREQREPLY		16		/* information reply */
    167 #define	ICMP_MASKREQ		17		/* address mask request */
    168 #define	ICMP_MASKREPLY		18		/* address mask reply */
    169 
    170 #define	ICMP_MAXTYPE		18
    171 
    172 #define	ICMP_INFOTYPE(type) \
    173 	((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
    174 	(type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
    175 	(type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
    176 	(type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
    177 	(type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
    178 
    179 #ifdef	__cplusplus
    180 }
    181 #endif
    182 
    183 #endif	/* _NETINET_IP_ICMP_H */
    184