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