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