sys/netinet/ip_icmp.h

   1 /*
   2  * Copyright (c) 1982, 1986, 1993
   3  *      The Regents of the University of California.  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  *
  33  *      @(#)ip_icmp.h   8.1 (Berkeley) 6/10/93
  34  * $FreeBSD: src/sys/netinet/ip_icmp.h,v 1.16 1999/12/29 04:41:01 peter Exp $
  35  * $DragonFly: src/sys/netinet/ip_icmp.h,v 1.8 2006/05/20 02:42:12 dillon Exp $
  36  */
  37
  38 #ifndef _NETINET_IP_ICMP_H_
  39 #define _NETINET_IP_ICMP_H_
  40
  41 #ifndef _SYS_TYPES_H_
  42 #include <sys/types.h>
  43 #endif
  44 #ifndef _NETINET_IN_SYSTM_H_
  45 #include <netinet/in_systm.h>
  46 #endif
  47 #ifndef _NETINET_IN_H_
  48 #include <netinet/in.h>
  49 #endif
  50 #ifndef _NETINET_IP_H_
  51 #include <netinet/ip.h>
  52 #endif
  53
  54 /*
  55  * Interface Control Message Protocol Definitions.
  56  * Per RFC 792, September 1981.
  57  */
  58
  59 /*
  60  * Internal of an ICMP Router Advertisement
  61  */
  62 struct icmp_ra_addr {
  63         u_int32_t ira_addr;
  64         u_int32_t ira_preference;
  65 };
  66
  67 /*
  68  * Structure of an icmp header.
  69  */
  70 struct icmp {
  71         u_char  icmp_type;              /* type of message, see below */
  72         u_char  icmp_code;              /* type sub code */
  73         u_short icmp_cksum;             /* ones complement cksum of struct */
  74         union {
  75                 u_char ih_pptr;                 /* ICMP_PARAMPROB */
  76                 struct in_addr ih_gwaddr;       /* ICMP_REDIRECT */
  77                 struct ih_idseq {
  78                         n_short icd_id;
  79                         n_short icd_seq;
  80                 } ih_idseq;
  81                 int ih_void;
  82
  83                 /* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
  84                 struct ih_pmtu {
  85                         n_short ipm_void;
  86                         n_short ipm_nextmtu;
  87                 } ih_pmtu;
  88
  89                 struct ih_rtradv {
  90                         u_char irt_num_addrs;
  91                         u_char irt_wpa;
  92                         u_int16_t irt_lifetime;
  93                 } ih_rtradv;
  94         } icmp_hun;
  95 #define icmp_pptr       icmp_hun.ih_pptr
  96 #define icmp_gwaddr     icmp_hun.ih_gwaddr
  97 #define icmp_id         icmp_hun.ih_idseq.icd_id
  98 #define icmp_seq        icmp_hun.ih_idseq.icd_seq
  99 #define icmp_void       icmp_hun.ih_void
 100 #define icmp_pmvoid     icmp_hun.ih_pmtu.ipm_void
 101 #define icmp_nextmtu    icmp_hun.ih_pmtu.ipm_nextmtu
 102 #define icmp_num_addrs  icmp_hun.ih_rtradv.irt_num_addrs
 103 #define icmp_wpa        icmp_hun.ih_rtradv.irt_wpa
 104 #define icmp_lifetime   icmp_hun.ih_rtradv.irt_lifetime
 105         union {
 106                 struct id_ts {
 107                         n_time its_otime;
 108                         n_time its_rtime;
 109                         n_time its_ttime;
 110                 } id_ts;
 111                 struct id_ip  {
 112                         struct ip idi_ip;
 113                         /* options and then 64 bits of data */
 114                 } id_ip;
 115                 struct icmp_ra_addr id_radv;
 116                 u_int32_t id_mask;
 117                 char    id_data[1];
 118         } icmp_dun;
 119 #define icmp_otime      icmp_dun.id_ts.its_otime
 120 #define icmp_rtime      icmp_dun.id_ts.its_rtime
 121 #define icmp_ttime      icmp_dun.id_ts.its_ttime
 122 #define icmp_ip         icmp_dun.id_ip.idi_ip
 123 #define icmp_radv       icmp_dun.id_radv
 124 #define icmp_mask       icmp_dun.id_mask
 125 #define icmp_data       icmp_dun.id_data
 126 };
 127
 128 /*
 129  * Lower bounds on packet lengths for various types.
 130  * For the error advice packets must first insure that the
 131  * packet is large enough to contain the returned ip header.
 132  * Only then can we do the check to see if 64 bits of packet
 133  * data have been returned, since we need to check the returned
 134  * ip header length.
 135  */
 136 #define ICMP_MINLEN     8                               /* abs minimum */
 137 #define ICMP_TSLEN      (8 + 3 * sizeof (n_time))       /* timestamp */
 138 #define ICMP_MASKLEN    12                              /* address mask */
 139 #define ICMP_ADVLENMIN  (8 + sizeof (struct ip) + 8)    /* min */
 140 #ifndef _IP_VHL
 141 #define ICMP_ADVLEN(p)  (8 + ((p)->icmp_ip.ip_hl << 2) + 8)
 142         /* N.B.: must separately check that ip_hl >= 5 */
 143 #else
 144 #define ICMP_ADVLEN(p)  (8 + (IP_VHL_HL((p)->icmp_ip.ip_vhl) << 2) + 8)
 145         /* N.B.: must separately check that header length >= 5 */
 146 #endif
 147
 148 /*
 149  * Definition of type and code field values.
 150  */
 151 #define ICMP_ECHOREPLY          0               /* echo reply */
 152 #define ICMP_UNREACH            3               /* dest unreachable, codes: */
 153 #define         ICMP_UNREACH_NET        0               /* bad net */
 154 #define         ICMP_UNREACH_HOST       1               /* bad host */
 155 #define         ICMP_UNREACH_PROTOCOL   2               /* bad protocol */
 156 #define         ICMP_UNREACH_PORT       3               /* bad port */
 157 #define         ICMP_UNREACH_NEEDFRAG   4               /* IP_DF caused drop */
 158 #define         ICMP_UNREACH_SRCFAIL    5               /* src route failed */
 159 #define         ICMP_UNREACH_NET_UNKNOWN 6              /* unknown net */
 160 #define         ICMP_UNREACH_HOST_UNKNOWN 7             /* unknown host */
 161 #define         ICMP_UNREACH_ISOLATED   8               /* src host isolated */
 162 #define         ICMP_UNREACH_NET_PROHIB 9               /* prohibited access */
 163 #define         ICMP_UNREACH_HOST_PROHIB 10             /* ditto */
 164 #define         ICMP_UNREACH_TOSNET     11              /* bad tos for net */
 165 #define         ICMP_UNREACH_TOSHOST    12              /* bad tos for host */
 166 #define         ICMP_UNREACH_FILTER_PROHIB 13           /* admin prohib */
 167 #define         ICMP_UNREACH_HOST_PRECEDENCE 14         /* host prec vio. */
 168 #define         ICMP_UNREACH_PRECEDENCE_CUTOFF 15       /* prec cutoff */
 169 #define ICMP_SOURCEQUENCH       4               /* packet lost, slow down */
 170 #define ICMP_REDIRECT           5               /* shorter route, codes: */
 171 #define         ICMP_REDIRECT_NET       0               /* for network */
 172 #define         ICMP_REDIRECT_HOST      1               /* for host */
 173 #define         ICMP_REDIRECT_TOSNET    2               /* for tos and net */
 174 #define         ICMP_REDIRECT_TOSHOST   3               /* for tos and host */
 175 #define ICMP_ALTHOSTADDR        6               /* alternate host address */
 176 #define ICMP_ECHO               8               /* echo service */
 177 #define ICMP_ROUTERADVERT       9               /* router advertisement */
 178 #define         ICMP_ROUTERADVERT_NORMAL 0              /* normal advertisement */
 179 #define         ICMP_ROUTERADVERT_NOROUTE_COMMON 16     /* selective routing */
 180 #define ICMP_ROUTERSOLICIT      10              /* router solicitation */
 181 #define ICMP_TIMXCEED           11              /* time exceeded, code: */
 182 #define         ICMP_TIMXCEED_INTRANS   0               /* ttl==0 in transit */
 183 #define         ICMP_TIMXCEED_REASS     1               /* ttl==0 in reass */
 184 #define ICMP_PARAMPROB          12              /* ip header bad */
 185 #define         ICMP_PARAMPROB_ERRATPTR 0               /* error at param ptr */
 186 #define         ICMP_PARAMPROB_OPTABSENT 1              /* req. opt. absent */
 187 #define         ICMP_PARAMPROB_LENGTH   2               /* bad length */
 188 #define ICMP_TSTAMP             13              /* timestamp request */
 189 #define ICMP_TSTAMPREPLY        14              /* timestamp reply */
 190 #define ICMP_IREQ               15              /* information request */
 191 #define ICMP_IREQREPLY          16              /* information reply */
 192 #define ICMP_MASKREQ            17              /* address mask request */
 193 #define ICMP_MASKREPLY          18              /* address mask reply */
 194 #define ICMP_TRACEROUTE         30              /* traceroute */
 195 #define ICMP_DATACONVERR        31              /* data conversion error */
 196 #define ICMP_MOBILE_REDIRECT    32              /* mobile host redirect */
 197 #define ICMP_IPV6_WHEREAREYOU   33              /* IPv6 where-are-you */
 198 #define ICMP_IPV6_IAMHERE       34              /* IPv6 i-am-here */
 199 #define ICMP_MOBILE_REGREQUEST  35              /* mobile registration req */
 200 #define ICMP_MOBILE_REGREPLY    36              /* mobile registreation reply */
 201 #define ICMP_SKIP               39              /* SKIP */
 202 #define ICMP_PHOTURIS           40              /* Photuris */
 203 #define     ICMP_PHOTURIS_UNKNOWN_INDEX 1               /* unknown sec index */
 204 #define     ICMP_PHOTURIS_AUTH_FAILED   2               /* auth failed */
 205 #define     ICMP_PHOTURIS_DECRYPT_FAILED 3              /* decrypt failed */
 206
 207 #define ICMP_MAXTYPE            40
 208
 209 #define ICMP_INFOTYPE(type) \
 210         ((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
 211         (type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
 212         (type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
 213         (type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
 214         (type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
 215
 216 #ifdef _KERNEL
 217 void    icmp_error (struct mbuf *, int, int, n_long, int);
 218 int     icmp_input (struct mbuf **, int *, int);
 219 int     ip_next_mtu (int, int);
 220 #endif
 221
 222 #endif