Update comments, cleanup warning messages.
[wine/multimedia.git] / dlls / icmp / ip_icmp.h
blob33e6375758d0dbd09e22c883c4f2982dd17e0a1a
1 /*
2 * Copyright (c) 1982, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
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.
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.
33 * @(#)ip_icmp.h 8.1 (Berkeley) 6/10/93
34 * $FreeBSD: src/sys/netinet/ip_icmp.h,v 1.13 1999/08/28 00:49:24 peter Exp $
37 #ifndef _NETINET_IP_ICMP_H_
38 #define _NETINET_IP_ICMP_H_
41 * Interface Control Message Protocol Definitions.
42 * Per RFC 792, September 1981.
46 * Internal of an ICMP Router Advertisement
48 struct icmp_ra_addr {
49 u_int32_t ira_addr;
50 u_int32_t ira_preference;
54 * Structure of an icmp header.
56 struct icmp {
57 u_char icmp_type; /* type of message, see below */
58 u_char icmp_code; /* type sub code */
59 u_short icmp_cksum; /* ones complement cksum of struct */
60 union {
61 u_char ih_pptr; /* ICMP_PARAMPROB */
62 struct in_addr ih_gwaddr; /* ICMP_REDIRECT */
63 struct ih_idseq {
64 n_short icd_id;
65 n_short icd_seq;
66 } ih_idseq;
67 int ih_void;
69 /* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
70 struct ih_pmtu {
71 n_short ipm_void;
72 n_short ipm_nextmtu;
73 } ih_pmtu;
75 struct ih_rtradv {
76 u_char irt_num_addrs;
77 u_char irt_wpa;
78 u_int16_t irt_lifetime;
79 } ih_rtradv;
80 } icmp_hun;
81 #define icmp_pptr icmp_hun.ih_pptr
82 #define icmp_gwaddr icmp_hun.ih_gwaddr
83 #define icmp_id icmp_hun.ih_idseq.icd_id
84 #define icmp_seq icmp_hun.ih_idseq.icd_seq
85 #define icmp_void icmp_hun.ih_void
86 #define icmp_pmvoid icmp_hun.ih_pmtu.ipm_void
87 #define icmp_nextmtu icmp_hun.ih_pmtu.ipm_nextmtu
88 #define icmp_num_addrs icmp_hun.ih_rtradv.irt_num_addrs
89 #define icmp_wpa icmp_hun.ih_rtradv.irt_wpa
90 #define icmp_lifetime icmp_hun.ih_rtradv.irt_lifetime
91 union {
92 struct id_ts {
93 n_time its_otime;
94 n_time its_rtime;
95 n_time its_ttime;
96 } id_ts;
97 struct id_ip {
98 struct ip idi_ip;
99 /* options and then 64 bits of data */
100 } id_ip;
101 struct icmp_ra_addr id_radv;
102 u_int32_t id_mask;
103 char id_data[1];
104 } icmp_dun;
105 #define icmp_otime icmp_dun.id_ts.its_otime
106 #define icmp_rtime icmp_dun.id_ts.its_rtime
107 #define icmp_ttime icmp_dun.id_ts.its_ttime
108 #define icmp_ip icmp_dun.id_ip.idi_ip
109 #define icmp_radv icmp_dun.id_radv
110 #define icmp_mask icmp_dun.id_mask
111 #define icmp_data icmp_dun.id_data
115 * Lower bounds on packet lengths for various types.
116 * For the error advice packets must first insure that the
117 * packet is large enough to contain the returned ip header.
118 * Only then can we do the check to see if 64 bits of packet
119 * data have been returned, since we need to check the returned
120 * ip header length.
122 #define ICMP_MINLEN 8 /* abs minimum */
123 #define ICMP_TSLEN (8 + 3 * sizeof (n_time)) /* timestamp */
124 #define ICMP_MASKLEN 12 /* address mask */
125 #define ICMP_ADVLENMIN (8 + sizeof (struct ip) + 8) /* min */
126 #ifndef _IP_VHL
127 #define ICMP_ADVLEN(p) (8 + ((p)->icmp_ip.ip_hl << 2) + 8)
128 /* N.B.: must separately check that ip_hl >= 5 */
129 #else
130 #define ICMP_ADVLEN(p) (8 + (IP_VHL_HL((p)->icmp_ip.ip_vhl) << 2) + 8)
131 /* N.B.: must separately check that header length >= 5 */
132 #endif
135 * Definition of type and code field values.
137 #define ICMP_ECHOREPLY 0 /* echo reply */
138 #define ICMP_UNREACH 3 /* dest unreachable, codes: */
139 #define ICMP_UNREACH_NET 0 /* bad net */
140 #define ICMP_UNREACH_HOST 1 /* bad host */
141 #define ICMP_UNREACH_PROTOCOL 2 /* bad protocol */
142 #define ICMP_UNREACH_PORT 3 /* bad port */
143 #define ICMP_UNREACH_NEEDFRAG 4 /* IP_DF caused drop */
144 #define ICMP_UNREACH_SRCFAIL 5 /* src route failed */
145 #define ICMP_UNREACH_NET_UNKNOWN 6 /* unknown net */
146 #define ICMP_UNREACH_HOST_UNKNOWN 7 /* unknown host */
147 #define ICMP_UNREACH_ISOLATED 8 /* src host isolated */
148 #define ICMP_UNREACH_NET_PROHIB 9 /* prohibited access */
149 #define ICMP_UNREACH_HOST_PROHIB 10 /* ditto */
150 #define ICMP_UNREACH_TOSNET 11 /* bad tos for net */
151 #define ICMP_UNREACH_TOSHOST 12 /* bad tos for host */
152 #define ICMP_UNREACH_FILTER_PROHIB 13 /* admin prohib */
153 #define ICMP_UNREACH_HOST_PRECEDENCE 14 /* host prec vio. */
154 #define ICMP_UNREACH_PRECEDENCE_CUTOFF 15 /* prec cutoff */
155 #define ICMP_SOURCEQUENCH 4 /* packet lost, slow down */
156 #define ICMP_REDIRECT 5 /* shorter route, codes: */
157 #define ICMP_REDIRECT_NET 0 /* for network */
158 #define ICMP_REDIRECT_HOST 1 /* for host */
159 #define ICMP_REDIRECT_TOSNET 2 /* for tos and net */
160 #define ICMP_REDIRECT_TOSHOST 3 /* for tos and host */
161 #define ICMP_ECHO 8 /* echo service */
162 #define ICMP_ROUTERADVERT 9 /* router advertisement */
163 #define ICMP_ROUTERSOLICIT 10 /* router solicitation */
164 #define ICMP_TIMXCEED 11 /* time exceeded, code: */
165 #define ICMP_TIMXCEED_INTRANS 0 /* ttl==0 in transit */
166 #define ICMP_TIMXCEED_REASS 1 /* ttl==0 in reass */
167 #define ICMP_PARAMPROB 12 /* ip header bad */
168 #define ICMP_PARAMPROB_OPTABSENT 1 /* req. opt. absent */
169 #define ICMP_TSTAMP 13 /* timestamp request */
170 #define ICMP_TSTAMPREPLY 14 /* timestamp reply */
171 #define ICMP_IREQ 15 /* information request */
172 #define ICMP_IREQREPLY 16 /* information reply */
173 #define ICMP_MASKREQ 17 /* address mask request */
174 #define ICMP_MASKREPLY 18 /* address mask reply */
176 #define ICMP_MAXTYPE 18
178 #define ICMP_INFOTYPE(type) \
179 ((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
180 (type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
181 (type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
182 (type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
183 (type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
185 #ifdef KERNEL
186 void icmp_error __P((struct mbuf *, int, int, n_long, struct ifnet *));
187 void icmp_input __P((struct mbuf *, int));
188 #endif
190 #endif