sys/netinet/ip_icmp.h

   1 /*      $OpenBSD: ip_icmp.h,v 1.9 1999/01/07 09:20:17 deraadt Exp $     */
   2 /*      $NetBSD: ip_icmp.h,v 1.10 1996/02/13 23:42:28 christos Exp $    */
   3
   4 /*
   5  * Copyright (c) 1982, 1986, 1993
   6  *      The Regents of the University of California.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)ip_icmp.h   8.1 (Berkeley) 6/10/93
  37  */
  38
  39 /*
  40  * Interface Control Message Protocol Definitions.
  41  * Per RFC 792, September 1981.
  42  */
  43
  44 /*
  45  * ICMP Router Advertisement data
  46  */
  47 struct icmp_ra_addr {
  48         n_long ira_addr;
  49         n_long 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
  74                 struct ih_rtradv {
  75                         u_int8_t irt_num_addrs;
  76                         u_int8_t irt_wpa;
  77                         n_short irt_lifetime;
  78                 } ih_rtradv;
  79         } icmp_hun;
  80 #define icmp_pptr         icmp_hun.ih_pptr
  81 #define icmp_gwaddr       icmp_hun.ih_gwaddr
  82 #define icmp_id           icmp_hun.ih_idseq.icd_id
  83 #define icmp_seq          icmp_hun.ih_idseq.icd_seq
  84 #define icmp_void         icmp_hun.ih_void
  85 #define icmp_pmvoid       icmp_hun.ih_pmtu.ipm_void
  86 #define icmp_nextmtu      icmp_hun.ih_pmtu.ipm_nextmtu
  87 #define icmp_num_addrs    icmp_hun.ih_rtradv.irt_num_addrs
  88 #define icmp_wpa          icmp_hun.ih_rtradv.irt_wpa
  89 #define icmp_lifetime     icmp_hun.ih_rtradv.irt_lifetime
  90         union {
  91                 struct id_ts {
  92                           n_time its_otime;
  93                           n_time its_rtime;
  94                           n_time its_ttime;
  95                 } id_ts;
  96                 struct id_ip  {
  97                           struct ip idi_ip;
  98                           /* options and then 64 bits of data */
  99                 } id_ip;
 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_mask         icmp_dun.id_mask
 108 #define icmp_data         icmp_dun.id_data
 109 };
 110
 111 /*
 112  * For IPv6 transition related ICMP errors.
 113  */
 114 #define ICMP_V6ADVLENMIN        (8 + sizeof(struct ip) + 40)
 115 #define ICMP_V6ADVLEN(p)        (8 + ((p)->icmp_ip.ip_hl << 2) + 40)
 116
 117 /*
 118  * Lower bounds on packet lengths for various types.
 119  * For the error advice packets must first insure that the
 120  * packet is large enought to contain the returned ip header.
 121  * Only then can we do the check to see if 64 bits of packet
 122  * data have been returned, since we need to check the returned
 123  * ip header length.
 124  */
 125 #define ICMP_MINLEN     8                               /* abs minimum */
 126 #define ICMP_TSLEN      (8 + 3 * sizeof (n_time))       /* timestamp */
 127 #define ICMP_MASKLEN    12                              /* address mask */
 128 #define ICMP_ADVLENMIN  (8 + sizeof (struct ip) + 8)    /* min */
 129 #define ICMP_ADVLEN(p)  (8 + ((p)->icmp_ip.ip_hl << 2) + 8)
 130         /* N.B.: must separately check that ip_hl >= 5 */
 131
 132 /*
 133  * Definition of type and code field values.
 134  */
 135 #define ICMP_ECHOREPLY          0               /* echo reply */
 136 #define ICMP_UNREACH            3               /* dest unreachable, codes: */
 137 #define         ICMP_UNREACH_NET                0       /* bad net */
 138 #define         ICMP_UNREACH_HOST               1       /* bad host */
 139 #define         ICMP_UNREACH_PROTOCOL           2       /* bad protocol */
 140 #define         ICMP_UNREACH_PORT               3       /* bad port */
 141 #define         ICMP_UNREACH_NEEDFRAG           4       /* IP_DF caused drop */
 142 #define         ICMP_UNREACH_SRCFAIL            5       /* src route failed */
 143 #define         ICMP_UNREACH_NET_UNKNOWN        6       /* unknown net */
 144 #define         ICMP_UNREACH_HOST_UNKNOWN       7       /* unknown host */
 145 #define         ICMP_UNREACH_ISOLATED           8       /* src host isolated */
 146 #define         ICMP_UNREACH_NET_PROHIB         9       /* for crypto devs */
 147 #define         ICMP_UNREACH_HOST_PROHIB        10      /* ditto */
 148 #define         ICMP_UNREACH_TOSNET             11      /* bad tos for net */
 149 #define         ICMP_UNREACH_TOSHOST            12      /* bad tos for host */
 150 #define         ICMP_UNREACH_FILTER_PROHIB      13      /* prohibited access */
 151 #define         ICMP_UNREACH_HOST_PRECEDENCE    14      /* precedence violat'n*/
 152 #define         ICMP_UNREACH_PRECEDENCE_CUTOFF  15      /* precedence cutoff */
 153 #define ICMP_SOURCEQUENCH       4               /* packet lost, slow down */
 154 #define ICMP_REDIRECT           5               /* shorter route, codes: */
 155 #define         ICMP_REDIRECT_NET       0               /* for network */
 156 #define         ICMP_REDIRECT_HOST      1               /* for host */
 157 #define         ICMP_REDIRECT_TOSNET    2               /* for tos and net */
 158 #define         ICMP_REDIRECT_TOSHOST   3               /* for tos and host */
 159 #define ICMP_ECHO               8               /* echo service */
 160 #define ICMP_ROUTERADVERT       9               /* router advertisement */
 161 #define ICMP_ROUTERSOLICIT      10              /* router solicitation */
 162 #define ICMP_TIMXCEED           11              /* time exceeded, code: */
 163 #define         ICMP_TIMXCEED_INTRANS   0               /* ttl==0 in transit */
 164 #define         ICMP_TIMXCEED_REASS     1               /* ttl==0 in reass */
 165 #define ICMP_PARAMPROB          12              /* ip header bad */
 166 #define         ICMP_PARAMPROB_OPTABSENT 1              /* req. opt. absent */
 167 #define ICMP_TSTAMP             13              /* timestamp request */
 168 #define ICMP_TSTAMPREPLY        14              /* timestamp reply */
 169 #define ICMP_IREQ               15              /* information request */
 170 #define ICMP_IREQREPLY          16              /* information reply */
 171 #define ICMP_MASKREQ            17              /* address mask request */
 172 #define ICMP_MASKREPLY          18              /* address mask reply */
 173
 174 #define ICMP_MAXTYPE            18
 175
 176 #define ICMP_INFOTYPE(type) \
 177         ((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
 178         (type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
 179         (type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
 180         (type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
 181         (type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
 182
 183 #ifdef _KERNEL
 184 void    icmp_error __P((struct mbuf *, int, int, n_long, struct ifnet *));
 185 void    icmp_input __P((struct mbuf *, ...));
 186 void    icmp_reflect __P((struct mbuf *));
 187 void    icmp_send __P((struct mbuf *, struct mbuf *));
 188 int     icmp_sysctl __P((int *, u_int, void *, size_t *, void *, size_t));
 189 #endif