1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/*
* Copyright (C) 2013 Michael Brown <mbrown@fensystems.co.uk>.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*
* You can also choose to distribute this program under the terms of
* the Unmodified Binary Distribution Licence (as given in the file
* COPYING.UBDL), provided that you have satisfied its requirements.
*/
FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
#include <string.h>
#include <byteswap.h>
#include <errno.h>
#include <ipxe/iobuf.h>
#include <ipxe/in.h>
#include <ipxe/tcpip.h>
#include <ipxe/ping.h>
#include <ipxe/crc32.h>
#include <ipxe/icmp.h>
/** @file
*
* ICMP protocol
*
*/
/**
* Identify ICMP echo protocol
*
* @v st_family Address family
* @ret echo_protocol ICMP echo protocol, or NULL
*/
static struct icmp_echo_protocol * icmp_echo_protocol ( sa_family_t family ) {
struct icmp_echo_protocol *echo_protocol;
for_each_table_entry ( echo_protocol, ICMP_ECHO_PROTOCOLS ) {
if ( echo_protocol->family == family )
return echo_protocol;
}
return NULL;
}
/**
*
* Determine debugging colour for ICMP debug messages
*
* @v st_peer Peer address
* @ret col Debugging colour (for DBGC())
*/
static uint32_t icmpcol ( struct sockaddr_tcpip *st_peer ) {
return crc32_le ( 0, st_peer, sizeof ( *st_peer ) );
}
/**
* Transmit ICMP echo packet
*
* @v iobuf I/O buffer
* @v st_dest Destination socket address
* @v echo_protocol ICMP echo protocol
* @ret rc Return status code
*/
static int icmp_tx_echo ( struct io_buffer *iobuf,
struct sockaddr_tcpip *st_dest,
struct icmp_echo_protocol *echo_protocol ) {
struct icmp_echo *echo = iobuf->data;
int rc;
/* Set ICMP type and (re)calculate checksum */
echo->icmp.chksum = 0;
echo->icmp.chksum = tcpip_chksum ( echo, iob_len ( iobuf ) );
/* Transmit packet */
if ( ( rc = tcpip_tx ( iobuf, echo_protocol->tcpip_protocol, NULL,
st_dest, NULL,
( echo_protocol->net_checksum ?
&echo->icmp.chksum : NULL ) ) ) != 0 )
return rc;
return 0;
}
/**
* Transmit ICMP echo request
*
* @v iobuf I/O buffer
* @v st_dest Destination socket address
* @ret rc Return status code
*/
int icmp_tx_echo_request ( struct io_buffer *iobuf,
struct sockaddr_tcpip *st_dest ) {
struct icmp_echo *echo = iobuf->data;
struct icmp_echo_protocol *echo_protocol;
int rc;
/* Identify ICMP echo protocol */
echo_protocol = icmp_echo_protocol ( st_dest->st_family );
if ( ! echo_protocol ) {
DBGC ( icmpcol ( st_dest ), "ICMP TX echo request unknown "
"address family %d\n", st_dest->st_family );
free_iob ( iobuf );
return -ENOTSUP;
}
/* Set type */
echo->icmp.type = echo_protocol->request;
/* Transmit request */
DBGC ( icmpcol ( st_dest ), "ICMP TX echo request id %04x seq %04x\n",
ntohs ( echo->ident ), ntohs ( echo->sequence ) );
if ( ( rc = icmp_tx_echo ( iobuf, st_dest, echo_protocol ) ) != 0 )
return rc;
return 0;
}
/**
* Transmit ICMP echo reply
*
* @v iobuf I/O buffer
* @v st_dest Destination socket address
* @ret rc Return status code
*/
static int icmp_tx_echo_reply ( struct io_buffer *iobuf,
struct sockaddr_tcpip *st_dest,
struct icmp_echo_protocol *echo_protocol ) {
struct icmp_echo *echo = iobuf->data;
int rc;
/* Set type */
echo->icmp.type = echo_protocol->reply;
/* Transmit reply */
DBGC ( icmpcol ( st_dest ), "ICMP TX echo reply id %04x seq %04x\n",
ntohs ( echo->ident ), ntohs ( echo->sequence ) );
if ( ( rc = icmp_tx_echo ( iobuf, st_dest, echo_protocol ) ) != 0 )
return rc;
return 0;
}
/**
* Process a received ICMP echo request
*
* @v iobuf I/O buffer
* @v st_src Source socket address
* @v echo_protocol ICMP echo protocol
* @ret rc Return status code
*/
int icmp_rx_echo_request ( struct io_buffer *iobuf,
struct sockaddr_tcpip *st_src,
struct icmp_echo_protocol *echo_protocol ) {
struct icmp_echo *echo = iobuf->data;
int rc;
/* Sanity check */
if ( iob_len ( iobuf ) < sizeof ( *echo ) ) {
DBGC ( icmpcol ( st_src ), "ICMP RX echo request too short at "
"%zd bytes (min %zd bytes)\n",
iob_len ( iobuf ), sizeof ( *echo ) );
free_iob ( iobuf );
return -EINVAL;
}
DBGC ( icmpcol ( st_src ), "ICMP RX echo request id %04x seq %04x\n",
ntohs ( echo->ident ), ntohs ( echo->sequence ) );
/* Transmit echo reply */
if ( ( rc = icmp_tx_echo_reply ( iobuf, st_src, echo_protocol ) ) != 0 )
return rc;
return 0;
}
/**
* Process a received ICMP echo request
*
* @v iobuf I/O buffer
* @v st_src Source socket address
* @ret rc Return status code
*/
int icmp_rx_echo_reply ( struct io_buffer *iobuf,
struct sockaddr_tcpip *st_src ) {
struct icmp_echo *echo = iobuf->data;
int rc;
/* Sanity check */
if ( iob_len ( iobuf ) < sizeof ( *echo ) ) {
DBGC ( icmpcol ( st_src ), "ICMP RX echo reply too short at "
"%zd bytes (min %zd bytes)\n",
iob_len ( iobuf ), sizeof ( *echo ) );
free_iob ( iobuf );
return -EINVAL;
}
DBGC ( icmpcol ( st_src ), "ICMP RX echo reply id %04x seq %04x\n",
ntohs ( echo->ident ), ntohs ( echo->sequence ) );
/* Deliver to ping protocol */
if ( ( rc = ping_rx ( iobuf, st_src ) ) != 0 )
return rc;
return 0;
}
/**
* Receive ping reply (when no ping protocol is present)
*
* @v iobuf I/O buffer
* @v st_src Source socket address
* @ret rc Return status code
*/
__weak int ping_rx ( struct io_buffer *iobuf,
struct sockaddr_tcpip *st_src __unused ) {
free_iob ( iobuf );
return 0;
}
|
