bsd/netinet/ip_icmp.h

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