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