bsd/netinet/ip_icmp.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * Copyright (c) 1982, 1986, 1993
  24  *      The Regents of the University of California.  All rights reserved.
  25  *
  26  * Redistribution and use in source and binary forms, with or without
  27  * modification, are permitted provided that the following conditions
  28  * are met:
  29  * 1. Redistributions of source code must retain the above copyright
  30  *    notice, this list of conditions and the following disclaimer.
  31  * 2. Redistributions in binary form must reproduce the above copyright
  32  *    notice, this list of conditions and the following disclaimer in the
  33  *    documentation and/or other materials provided with the distribution.
  34  * 3. All advertising materials mentioning features or use of this software
  35  *    must display the following acknowledgement:
  36  *      This product includes software developed by the University of
  37  *      California, Berkeley and its contributors.
  38  * 4. Neither the name of the University nor the names of its contributors
  39  *    may be used to endorse or promote products derived from this software
  40  *    without specific prior written permission.
  41  *
  42  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  43  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  45  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  46  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  47  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  48  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  50  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  51  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52  * SUCH DAMAGE.
  53  *
  54  *      @(#)ip_icmp.h   8.1 (Berkeley) 6/10/93
  55  * $FreeBSD: src/sys/netinet/ip_icmp.h,v 1.16 1999/12/29 04:41:01 peter Exp $
  56  */
  57
  58 #ifndef _NETINET_IP_ICMP_H_
  59 #define _NETINET_IP_ICMP_H_
  60 #include <sys/appleapiopts.h>
  61
  62 /*
  63  * Interface Control Message Protocol Definitions.
  64  * Per RFC 792, September 1981.
  65  */
  66
  67 /*
  68  * Internal of an ICMP Router Advertisement
  69  */
  70 struct icmp_ra_addr {
  71         u_int32_t ira_addr;
  72         u_int32_t ira_preference;
  73 };
  74
  75 /*
  76  * Structure of an icmp header.
  77  */
  78 struct icmp {
  79         u_char  icmp_type;              /* type of message, see below */
  80         u_char  icmp_code;              /* type sub code */
  81         u_short icmp_cksum;             /* ones complement cksum of struct */
  82         union {
  83                 u_char ih_pptr;                 /* ICMP_PARAMPROB */
  84                 struct in_addr ih_gwaddr;       /* ICMP_REDIRECT */
  85                 struct ih_idseq {
  86                         n_short icd_id;
  87                         n_short icd_seq;
  88                 } ih_idseq;
  89                 int ih_void;
  90
  91                 /* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
  92                 struct ih_pmtu {
  93                         n_short ipm_void;
  94                         n_short ipm_nextmtu;
  95                 } ih_pmtu;
  96
  97                 struct ih_rtradv {
  98                         u_char irt_num_addrs;
  99                         u_char irt_wpa;
 100                         u_int16_t irt_lifetime;
 101                 } ih_rtradv;
 102         } icmp_hun;
 103 #define icmp_pptr       icmp_hun.ih_pptr
 104 #define icmp_gwaddr     icmp_hun.ih_gwaddr
 105 #define icmp_id         icmp_hun.ih_idseq.icd_id
 106 #define icmp_seq        icmp_hun.ih_idseq.icd_seq
 107 #define icmp_void       icmp_hun.ih_void
 108 #define icmp_pmvoid     icmp_hun.ih_pmtu.ipm_void
 109 #define icmp_nextmtu    icmp_hun.ih_pmtu.ipm_nextmtu
 110 #define icmp_num_addrs  icmp_hun.ih_rtradv.irt_num_addrs
 111 #define icmp_wpa        icmp_hun.ih_rtradv.irt_wpa
 112 #define icmp_lifetime   icmp_hun.ih_rtradv.irt_lifetime
 113         union {
 114                 struct id_ts {
 115                         n_time its_otime;
 116                         n_time its_rtime;
 117                         n_time its_ttime;
 118                 } id_ts;
 119                 struct id_ip  {
 120                         struct ip idi_ip;
 121                         /* options and then 64 bits of data */
 122                 } id_ip;
 123                 struct icmp_ra_addr id_radv;
 124                 u_int32_t id_mask;
 125                 char    id_data[1];
 126         } icmp_dun;
 127 #define icmp_otime      icmp_dun.id_ts.its_otime
 128 #define icmp_rtime      icmp_dun.id_ts.its_rtime
 129 #define icmp_ttime      icmp_dun.id_ts.its_ttime
 130 #define icmp_ip         icmp_dun.id_ip.idi_ip
 131 #define icmp_radv       icmp_dun.id_radv
 132 #define icmp_mask       icmp_dun.id_mask
 133 #define icmp_data       icmp_dun.id_data
 134 };
 135
 136 /*
 137  * Lower bounds on packet lengths for various types.
 138  * For the error advice packets must first insure that the
 139  * packet is large enough to contain the returned ip header.
 140  * Only then can we do the check to see if 64 bits of packet
 141  * data have been returned, since we need to check the returned
 142  * ip header length.
 143  */
 144 #define ICMP_MINLEN     8                               /* abs minimum */
 145 #define ICMP_TSLEN      (8 + 3 * sizeof (n_time))       /* timestamp */
 146 #define ICMP_MASKLEN    12                              /* address mask */
 147 #define ICMP_ADVLENMIN  (8 + sizeof (struct ip) + 8)    /* min */
 148 #ifndef _IP_VHL
 149 #define ICMP_ADVLEN(p)  (8 + ((p)->icmp_ip.ip_hl << 2) + 8)
 150         /* N.B.: must separately check that ip_hl >= 5 */
 151 #else
 152 #define ICMP_ADVLEN(p)  (8 + (IP_VHL_HL((p)->icmp_ip.ip_vhl) << 2) + 8)
 153         /* N.B.: must separately check that header length >= 5 */
 154 #endif
 155
 156 /*
 157  * Definition of type and code field values.
 158  */
 159 #define ICMP_ECHOREPLY          0               /* echo reply */
 160 #define ICMP_UNREACH            3               /* dest unreachable, codes: */
 161 #define         ICMP_UNREACH_NET        0               /* bad net */
 162 #define         ICMP_UNREACH_HOST       1               /* bad host */
 163 #define         ICMP_UNREACH_PROTOCOL   2               /* bad protocol */
 164 #define         ICMP_UNREACH_PORT       3               /* bad port */
 165 #define         ICMP_UNREACH_NEEDFRAG   4               /* IP_DF caused drop */
 166 #define         ICMP_UNREACH_SRCFAIL    5               /* src route failed */
 167 #define         ICMP_UNREACH_NET_UNKNOWN 6              /* unknown net */
 168 #define         ICMP_UNREACH_HOST_UNKNOWN 7             /* unknown host */
 169 #define         ICMP_UNREACH_ISOLATED   8               /* src host isolated */
 170 #define         ICMP_UNREACH_NET_PROHIB 9               /* prohibited access */
 171 #define         ICMP_UNREACH_HOST_PROHIB 10             /* ditto */
 172 #define         ICMP_UNREACH_TOSNET     11              /* bad tos for net */
 173 #define         ICMP_UNREACH_TOSHOST    12              /* bad tos for host */
 174 #define         ICMP_UNREACH_FILTER_PROHIB 13           /* admin prohib */
 175 #define         ICMP_UNREACH_HOST_PRECEDENCE 14         /* host prec vio. */
 176 #define         ICMP_UNREACH_PRECEDENCE_CUTOFF 15       /* prec cutoff */
 177 #define ICMP_SOURCEQUENCH       4               /* packet lost, slow down */
 178 #define ICMP_REDIRECT           5               /* shorter route, codes: */
 179 #define         ICMP_REDIRECT_NET       0               /* for network */
 180 #define         ICMP_REDIRECT_HOST      1               /* for host */
 181 #define         ICMP_REDIRECT_TOSNET    2               /* for tos and net */
 182 #define         ICMP_REDIRECT_TOSHOST   3               /* for tos and host */
 183 #define ICMP_ECHO               8               /* echo service */
 184 #define ICMP_ROUTERADVERT       9               /* router advertisement */
 185 #define ICMP_ROUTERSOLICIT      10              /* router solicitation */
 186 #define ICMP_TIMXCEED           11              /* time exceeded, code: */
 187 #define         ICMP_TIMXCEED_INTRANS   0               /* ttl==0 in transit */
 188 #define         ICMP_TIMXCEED_REASS     1               /* ttl==0 in reass */
 189 #define ICMP_PARAMPROB          12              /* ip header bad */
 190 #define         ICMP_PARAMPROB_ERRATPTR 0               /* error at param ptr */
 191 #define         ICMP_PARAMPROB_OPTABSENT 1              /* req. opt. absent */
 192 #define         ICMP_PARAMPROB_LENGTH 2                 /* bad length */
 193 #define ICMP_TSTAMP             13              /* timestamp request */
 194 #define ICMP_TSTAMPREPLY        14              /* timestamp reply */
 195 #define ICMP_IREQ               15              /* information request */
 196 #define ICMP_IREQREPLY          16              /* information reply */
 197 #define ICMP_MASKREQ            17              /* address mask request */
 198 #define ICMP_MASKREPLY          18              /* address mask reply */
 199
 200 #define ICMP_MAXTYPE            18
 201
 202 #define ICMP_INFOTYPE(type) \
 203         ((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
 204         (type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
 205         (type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
 206         (type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
 207         (type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
 208
 209 #ifdef KERNEL
 210 #ifdef __APPLE_API_PRIVATE
 211 void    icmp_error __P((struct mbuf *, int, int, n_long, struct ifnet *));
 212 void    icmp_input __P((struct mbuf *, int));
 213 #endif /* __APPLE_API_PRIVATE */
 214 #endif
 215
 216 #endif