blob: fa4a0e1227664f85c48767134e0c37f24c630053 [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15/*
16 * ip/icmp4.c: ipv4 icmp
17 *
18 * Copyright (c) 2008 Eliot Dresselhaus
19 *
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
27 *
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
30 *
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38 */
39
40#include <vlib/vlib.h>
41#include <vnet/ip/ip.h>
42#include <vnet/pg/pg.h>
Ole Troan8034a362021-08-11 13:54:14 +020043#include <vnet/ip/ip_sas.h>
Neale Ranns5c6dd172022-02-17 09:08:47 +000044#include <vnet/util/throttle.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070045
Neale Ranns5c6dd172022-02-17 09:08:47 +000046/** ICMP throttling */
47static throttle_t icmp_throttle;
48
Dave Barachd7cb1b52016-12-09 09:52:16 -050049static u8 *
50format_ip4_icmp_type_and_code (u8 * s, va_list * args)
Ed Warnickecb9cada2015-12-08 15:45:58 -070051{
52 icmp4_type_t type = va_arg (*args, int);
53 u8 code = va_arg (*args, int);
Dave Barachd7cb1b52016-12-09 09:52:16 -050054 char *t = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -070055
56#define _(n,f) case n: t = #f; break;
57
58 switch (type)
59 {
60 foreach_icmp4_type;
61
62 default:
63 break;
64 }
65
66#undef _
67
Dave Barachd7cb1b52016-12-09 09:52:16 -050068 if (!t)
Ed Warnickecb9cada2015-12-08 15:45:58 -070069 return format (s, "unknown 0x%x", type);
70
71 s = format (s, "%s", t);
72
73 t = 0;
74 switch ((type << 8) | code)
75 {
76#define _(a,n,f) case (ICMP4_##a << 8) | (n): t = #f; break;
77
78 foreach_icmp4_code;
79
80#undef _
81 }
82
83 if (t)
84 s = format (s, " %s", t);
85
86 return s;
87}
88
Dave Barachd7cb1b52016-12-09 09:52:16 -050089static u8 *
90format_ip4_icmp_header (u8 * s, va_list * args)
Ed Warnickecb9cada2015-12-08 15:45:58 -070091{
Dave Barachd7cb1b52016-12-09 09:52:16 -050092 icmp46_header_t *icmp = va_arg (*args, icmp46_header_t *);
Ed Warnickecb9cada2015-12-08 15:45:58 -070093 u32 max_header_bytes = va_arg (*args, u32);
94
95 /* Nothing to do. */
96 if (max_header_bytes < sizeof (icmp[0]))
97 return format (s, "ICMP header truncated");
98
99 s = format (s, "ICMP %U checksum 0x%x",
100 format_ip4_icmp_type_and_code, icmp->type, icmp->code,
101 clib_net_to_host_u16 (icmp->checksum));
102
Klement Sekera78ef61e2020-11-25 16:47:00 +0000103 if ((ICMP4_echo_request == icmp->type || ICMP4_echo_reply == icmp->type)
104 && sizeof (icmp[0]) + sizeof (u16) < max_header_bytes)
105 {
106 s = format (s, " id %u", clib_net_to_host_u16 (*(u16 *) (icmp + 1)));
107 }
108
Ed Warnickecb9cada2015-12-08 15:45:58 -0700109 return s;
110}
111
Dave Barachd7cb1b52016-12-09 09:52:16 -0500112static u8 *
113format_icmp_input_trace (u8 * s, va_list * va)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700114{
115 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
116 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
Dave Barachd7cb1b52016-12-09 09:52:16 -0500117 icmp_input_trace_t *t = va_arg (*va, icmp_input_trace_t *);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700118
119 s = format (s, "%U",
Dave Barachd7cb1b52016-12-09 09:52:16 -0500120 format_ip4_header, t->packet_data, sizeof (t->packet_data));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700121
122 return s;
123}
124
Dave Barachd7cb1b52016-12-09 09:52:16 -0500125typedef enum
126{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700127 ICMP_INPUT_NEXT_ERROR,
128 ICMP_INPUT_N_NEXT,
129} icmp_input_next_t;
130
Dave Barachd7cb1b52016-12-09 09:52:16 -0500131typedef struct
132{
133 uword *type_and_code_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700134
Dave Barachd7cb1b52016-12-09 09:52:16 -0500135 uword *type_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700136
137 /* Vector dispatch table indexed by [icmp type]. */
138 u8 ip4_input_next_index_by_type[256];
139} icmp4_main_t;
140
141icmp4_main_t icmp4_main;
142
143static uword
144ip4_icmp_input (vlib_main_t * vm,
Dave Barachd7cb1b52016-12-09 09:52:16 -0500145 vlib_node_runtime_t * node, vlib_frame_t * frame)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700146{
Dave Barachd7cb1b52016-12-09 09:52:16 -0500147 icmp4_main_t *im = &icmp4_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700148 uword n_packets = frame->n_vectors;
Dave Barachd7cb1b52016-12-09 09:52:16 -0500149 u32 *from, *to_next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700150 u32 n_left_from, n_left_to_next, next;
151
152 from = vlib_frame_vector_args (frame);
153 n_left_from = n_packets;
154 next = node->cached_next_index;
Dave Barachd7cb1b52016-12-09 09:52:16 -0500155
Ed Warnickecb9cada2015-12-08 15:45:58 -0700156 if (node->flags & VLIB_NODE_FLAG_TRACE)
157 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
158 /* stride */ 1,
159 sizeof (icmp_input_trace_t));
160
161 while (n_left_from > 0)
162 {
163 vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
164
165 while (n_left_from > 0 && n_left_to_next > 0)
166 {
Dave Barachd7cb1b52016-12-09 09:52:16 -0500167 vlib_buffer_t *p0;
168 ip4_header_t *ip0;
169 icmp46_header_t *icmp0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700170 icmp4_type_t type0;
171 u32 bi0, next0;
Dave Barachd7cb1b52016-12-09 09:52:16 -0500172
173 if (PREDICT_TRUE (n_left_from > 2))
174 {
175 vlib_prefetch_buffer_with_index (vm, from[2], LOAD);
176 p0 = vlib_get_buffer (vm, from[1]);
177 ip0 = vlib_buffer_get_current (p0);
Damjan Marionaf7fb042021-07-15 11:54:41 +0200178 clib_prefetch_load (ip0);
Dave Barachd7cb1b52016-12-09 09:52:16 -0500179 }
180
Ed Warnickecb9cada2015-12-08 15:45:58 -0700181 bi0 = to_next[0] = from[0];
182
183 from += 1;
184 n_left_from -= 1;
185 to_next += 1;
186 n_left_to_next -= 1;
Dave Barachd7cb1b52016-12-09 09:52:16 -0500187
Ed Warnickecb9cada2015-12-08 15:45:58 -0700188 p0 = vlib_get_buffer (vm, bi0);
189 ip0 = vlib_buffer_get_current (p0);
190 icmp0 = ip4_next_header (ip0);
191 type0 = icmp0->type;
192 next0 = im->ip4_input_next_index_by_type[type0];
193
194 p0->error = node->errors[ICMP4_ERROR_UNKNOWN_TYPE];
jackiechen198523551d62019-04-30 17:01:29 +0800195
196 /* Verify speculative enqueue, maybe switch current next frame */
197 vlib_validate_buffer_enqueue_x1 (vm, node, next, to_next,
198 n_left_to_next, bi0, next0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700199 }
Dave Barachd7cb1b52016-12-09 09:52:16 -0500200
Ed Warnickecb9cada2015-12-08 15:45:58 -0700201 vlib_put_next_frame (vm, node, next, n_left_to_next);
202 }
203
204 return frame->n_vectors;
205}
206
Neale Rannsf6c8f502019-10-25 01:40:47 -0700207VLIB_REGISTER_NODE (ip4_icmp_input_node) = {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700208 .function = ip4_icmp_input,
209 .name = "ip4-icmp-input",
210
211 .vector_size = sizeof (u32),
212
213 .format_trace = format_icmp_input_trace,
214
Neale Rannsb29c6062022-08-12 01:50:24 +0000215 .n_errors = ICMP4_N_ERROR,
216 .error_counters = icmp4_error_counters,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700217
218 .n_next_nodes = 1,
219 .next_nodes = {
Vijayabhaskar Katamreddyce074122017-11-15 13:50:26 -0800220 [ICMP_INPUT_NEXT_ERROR] = "ip4-punt",
Ed Warnickecb9cada2015-12-08 15:45:58 -0700221 },
222};
223
Dave Barachd7cb1b52016-12-09 09:52:16 -0500224typedef enum
225{
Ole Troan92eade12016-01-13 20:17:08 +0100226 IP4_ICMP_ERROR_NEXT_DROP,
227 IP4_ICMP_ERROR_NEXT_LOOKUP,
228 IP4_ICMP_ERROR_N_NEXT,
229} ip4_icmp_error_next_t;
230
Ole Troan92eade12016-01-13 20:17:08 +0100231static u8
232icmp4_icmp_type_to_error (u8 type)
233{
Dave Barachd7cb1b52016-12-09 09:52:16 -0500234 switch (type)
235 {
236 case ICMP4_destination_unreachable:
237 return ICMP4_ERROR_DEST_UNREACH_SENT;
238 case ICMP4_time_exceeded:
239 return ICMP4_ERROR_TTL_EXPIRE_SENT;
240 case ICMP4_parameter_problem:
241 return ICMP4_ERROR_PARAM_PROBLEM_SENT;
242 default:
243 return ICMP4_ERROR_DROP;
244 }
Ole Troan92eade12016-01-13 20:17:08 +0100245}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700246
247static uword
Ole Troan92eade12016-01-13 20:17:08 +0100248ip4_icmp_error (vlib_main_t * vm,
Dave Barachd7cb1b52016-12-09 09:52:16 -0500249 vlib_node_runtime_t * node, vlib_frame_t * frame)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700250{
Dave Barachd7cb1b52016-12-09 09:52:16 -0500251 u32 *from, *to_next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700252 uword n_left_from, n_left_to_next;
Ole Troan92eade12016-01-13 20:17:08 +0100253 ip4_icmp_error_next_t next_index;
Neale Ranns5c6dd172022-02-17 09:08:47 +0000254 u32 thread_index = vm->thread_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700255
Dave Barachd7cb1b52016-12-09 09:52:16 -0500256 from = vlib_frame_vector_args (frame);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700257 n_left_from = frame->n_vectors;
258 next_index = node->cached_next_index;
259
Neale Ranns5c6dd172022-02-17 09:08:47 +0000260 u64 seed = throttle_seed (&icmp_throttle, thread_index, vlib_time_now (vm));
261
Ed Warnickecb9cada2015-12-08 15:45:58 -0700262 if (node->flags & VLIB_NODE_FLAG_TRACE)
263 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
Dave Barachd7cb1b52016-12-09 09:52:16 -0500264 /* stride */ 1,
265 sizeof (icmp_input_trace_t));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700266
Dave Barachd7cb1b52016-12-09 09:52:16 -0500267 while (n_left_from > 0)
268 {
269 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700270
Dave Barachd7cb1b52016-12-09 09:52:16 -0500271 while (n_left_from > 0 && n_left_to_next > 0)
272 {
Ole Troanda7f7b62019-03-11 13:15:54 +0100273 /*
274 * Duplicate first buffer and free the original chain. Keep
275 * as much of the original packet as possible, within the
276 * minimum MTU. We chat "a little" here by keeping whatever
277 * is available in the first buffer.
278 */
279
280 u32 pi0 = ~0;
281 u32 org_pi0 = from[0];
Dave Barachd7cb1b52016-12-09 09:52:16 -0500282 u32 next0 = IP4_ICMP_ERROR_NEXT_LOOKUP;
283 u8 error0 = ICMP4_ERROR_NONE;
Ole Troanda7f7b62019-03-11 13:15:54 +0100284 vlib_buffer_t *p0, *org_p0;
Dave Barachd7cb1b52016-12-09 09:52:16 -0500285 ip4_header_t *ip0, *out_ip0;
286 icmp46_header_t *icmp0;
Ole Troan8034a362021-08-11 13:54:14 +0200287 u32 sw_if_index0;
Dave Barachd7cb1b52016-12-09 09:52:16 -0500288 ip_csum_t sum;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700289
Ole Troanda7f7b62019-03-11 13:15:54 +0100290 org_p0 = vlib_get_buffer (vm, org_pi0);
Neale Ranns5c6dd172022-02-17 09:08:47 +0000291 ip0 = vlib_buffer_get_current (org_p0);
292
293 /* Rate limit based on the src,dst addresses in the original packet
294 */
295 u64 r0 =
296 (u64) ip0->dst_address.as_u32 << 32 | ip0->src_address.as_u32;
297
298 if (throttle_check (&icmp_throttle, thread_index, r0, seed))
299 {
300 vlib_error_count (vm, node->node_index, ICMP4_ERROR_DROP, 1);
301 from += 1;
302 n_left_from -= 1;
303 continue;
304 }
305
Ole Troanda7f7b62019-03-11 13:15:54 +0100306 p0 = vlib_buffer_copy_no_chain (vm, org_p0, &pi0);
Ole Troanda7f7b62019-03-11 13:15:54 +0100307 if (!p0 || pi0 == ~0) /* Out of buffers */
308 continue;
309
Dave Barachd7cb1b52016-12-09 09:52:16 -0500310 /* Speculatively enqueue p0 to the current next frame */
311 to_next[0] = pi0;
312 from += 1;
313 to_next += 1;
314 n_left_from -= 1;
315 n_left_to_next -= 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700316
Dave Barachd7cb1b52016-12-09 09:52:16 -0500317 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700318
Klement Sekera5163d592022-11-14 11:29:17 +0100319 vlib_buffer_copy_trace_flag (vm, org_p0, pi0);
Neale Ranns5c6dd172022-02-17 09:08:47 +0000320
Dave Barachd7cb1b52016-12-09 09:52:16 -0500321 /* Add IP header and ICMPv4 header including a 4 byte data field */
322 vlib_buffer_advance (p0,
323 -sizeof (ip4_header_t) -
324 sizeof (icmp46_header_t) - 4);
Ole Troan8a9c8f12018-05-18 11:01:31 +0200325
Maxime Peim2cc14de2024-02-12 10:08:03 +0100326 p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
Ole Troan8a9c8f12018-05-18 11:01:31 +0200327 p0->current_length =
328 p0->current_length > 576 ? 576 : p0->current_length;
Dave Barachd7cb1b52016-12-09 09:52:16 -0500329 out_ip0 = vlib_buffer_get_current (p0);
330 icmp0 = (icmp46_header_t *) & out_ip0[1];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700331
Dave Barachd7cb1b52016-12-09 09:52:16 -0500332 /* Fill ip header fields */
333 out_ip0->ip_version_and_header_length = 0x45;
334 out_ip0->tos = 0;
335 out_ip0->length = clib_host_to_net_u16 (p0->current_length);
336 out_ip0->fragment_id = 0;
337 out_ip0->flags_and_fragment_offset = 0;
338 out_ip0->ttl = 0xff;
339 out_ip0->protocol = IP_PROTOCOL_ICMP;
340 out_ip0->dst_address = ip0->src_address;
Ole Troan8034a362021-08-11 13:54:14 +0200341 /* Prefer a source address from "offending interface" */
342 if (!ip4_sas_by_sw_if_index (sw_if_index0, &out_ip0->dst_address,
343 &out_ip0->src_address))
lijinhui8188f472024-04-15 10:07:46 +0800344 { /* interface has no IP4 address - should not happen */
Dave Barachd7cb1b52016-12-09 09:52:16 -0500345 next0 = IP4_ICMP_ERROR_NEXT_DROP;
346 error0 = ICMP4_ERROR_DROP;
347 }
Ole Troan8034a362021-08-11 13:54:14 +0200348
Dave Barachd7cb1b52016-12-09 09:52:16 -0500349 out_ip0->checksum = ip4_header_checksum (out_ip0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700350
Dave Barachd7cb1b52016-12-09 09:52:16 -0500351 /* Fill icmp header fields */
352 icmp0->type = vnet_buffer (p0)->ip.icmp.type;
353 icmp0->code = vnet_buffer (p0)->ip.icmp.code;
354 *((u32 *) (icmp0 + 1)) =
355 clib_host_to_net_u32 (vnet_buffer (p0)->ip.icmp.data);
356 icmp0->checksum = 0;
357 sum =
358 ip_incremental_checksum (0, icmp0,
359 p0->current_length -
360 sizeof (ip4_header_t));
361 icmp0->checksum = ~ip_csum_fold (sum);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700362
Dave Barachd7cb1b52016-12-09 09:52:16 -0500363 /* Update error status */
364 if (error0 == ICMP4_ERROR_NONE)
365 error0 = icmp4_icmp_type_to_error (icmp0->type);
Ole Troanda7f7b62019-03-11 13:15:54 +0100366
Dave Barachd7cb1b52016-12-09 09:52:16 -0500367 vlib_error_count (vm, node->node_index, error0, 1);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700368
Dave Barachd7cb1b52016-12-09 09:52:16 -0500369 /* Verify speculative enqueue, maybe switch current next frame */
370 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
371 to_next, n_left_to_next,
372 pi0, next0);
373 }
374 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700375 }
376
Kingwel Xie27431dd2019-03-20 21:47:17 -0400377 /*
378 * push the original buffers to error-drop, so that
379 * they can get the error counters handled, then freed
380 */
381 vlib_buffer_enqueue_to_single_next (vm, node,
382 vlib_frame_vector_args (frame),
383 IP4_ICMP_ERROR_NEXT_DROP,
384 frame->n_vectors);
385
Ed Warnickecb9cada2015-12-08 15:45:58 -0700386 return frame->n_vectors;
387}
388
Ole Troan92eade12016-01-13 20:17:08 +0100389VLIB_REGISTER_NODE (ip4_icmp_error_node) = {
390 .function = ip4_icmp_error,
391 .name = "ip4-icmp-error",
Ed Warnickecb9cada2015-12-08 15:45:58 -0700392 .vector_size = sizeof (u32),
393
Neale Rannsb29c6062022-08-12 01:50:24 +0000394 .n_errors = ICMP4_N_ERROR,
395 .error_counters = icmp4_error_counters,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700396
Ole Troan92eade12016-01-13 20:17:08 +0100397 .n_next_nodes = IP4_ICMP_ERROR_N_NEXT,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700398 .next_nodes = {
Vijayabhaskar Katamreddyce074122017-11-15 13:50:26 -0800399 [IP4_ICMP_ERROR_NEXT_DROP] = "ip4-drop",
Ole Troan92eade12016-01-13 20:17:08 +0100400 [IP4_ICMP_ERROR_NEXT_LOOKUP] = "ip4-lookup",
Ed Warnickecb9cada2015-12-08 15:45:58 -0700401 },
402
403 .format_trace = format_icmp_input_trace,
404};
405
406
Dave Barachd7cb1b52016-12-09 09:52:16 -0500407static uword
408unformat_icmp_type_and_code (unformat_input_t * input, va_list * args)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700409{
Dave Barachd7cb1b52016-12-09 09:52:16 -0500410 icmp46_header_t *h = va_arg (*args, icmp46_header_t *);
411 icmp4_main_t *cm = &icmp4_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700412 u32 i;
413
414 if (unformat_user (input, unformat_vlib_number_by_name,
415 cm->type_and_code_by_name, &i))
416 {
417 h->type = (i >> 8) & 0xff;
418 h->code = (i >> 0) & 0xff;
419 }
420 else if (unformat_user (input, unformat_vlib_number_by_name,
421 cm->type_by_name, &i))
422 {
423 h->type = i;
424 h->code = 0;
425 }
426 else
427 return 0;
428
429 return 1;
430}
431
432static void
433icmp4_pg_edit_function (pg_main_t * pg,
434 pg_stream_t * s,
Dave Barachd7cb1b52016-12-09 09:52:16 -0500435 pg_edit_group_t * g, u32 * packets, u32 n_packets)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700436{
Dave Barachd7cb1b52016-12-09 09:52:16 -0500437 vlib_main_t *vm = vlib_get_main ();
Ed Warnickecb9cada2015-12-08 15:45:58 -0700438 u32 ip_offset, icmp_offset;
439
440 icmp_offset = g->start_byte_offset;
Dave Barachd7cb1b52016-12-09 09:52:16 -0500441 ip_offset = (g - 1)->start_byte_offset;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700442
443 while (n_packets >= 1)
444 {
Dave Barachd7cb1b52016-12-09 09:52:16 -0500445 vlib_buffer_t *p0;
446 ip4_header_t *ip0;
447 icmp46_header_t *icmp0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700448 u32 len0;
449
450 p0 = vlib_get_buffer (vm, packets[0]);
451 n_packets -= 1;
452 packets += 1;
453
454 ASSERT (p0->current_data == 0);
455 ip0 = (void *) (p0->data + ip_offset);
456 icmp0 = (void *) (p0->data + icmp_offset);
Kingwel Xiea91866f2018-10-26 23:26:06 -0400457
458 /* if IP length has been specified, then calculate the length based on buffer */
459 if (ip0->length == 0)
460 len0 = vlib_buffer_length_in_chain (vm, p0) - icmp_offset;
461 else
462 len0 = clib_net_to_host_u16 (ip0->length) - icmp_offset;
463
Dave Barachd7cb1b52016-12-09 09:52:16 -0500464 icmp0->checksum =
465 ~ip_csum_fold (ip_incremental_checksum (0, icmp0, len0));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700466 }
467}
468
Dave Barachd7cb1b52016-12-09 09:52:16 -0500469typedef struct
470{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700471 pg_edit_t type, code;
472 pg_edit_t checksum;
473} pg_icmp46_header_t;
474
475always_inline void
476pg_icmp_header_init (pg_icmp46_header_t * p)
477{
478 /* Initialize fields that are not bit fields in the IP header. */
479#define _(f) pg_edit_init (&p->f, icmp46_header_t, f);
Dave Barachd7cb1b52016-12-09 09:52:16 -0500480 _(type);
481 _(code);
482 _(checksum);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700483#undef _
484}
485
486static uword
487unformat_pg_icmp_header (unformat_input_t * input, va_list * args)
488{
Dave Barachd7cb1b52016-12-09 09:52:16 -0500489 pg_stream_t *s = va_arg (*args, pg_stream_t *);
490 pg_icmp46_header_t *p;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700491 u32 group_index;
Dave Barachd7cb1b52016-12-09 09:52:16 -0500492
Ed Warnickecb9cada2015-12-08 15:45:58 -0700493 p = pg_create_edit_group (s, sizeof (p[0]), sizeof (icmp46_header_t),
494 &group_index);
495 pg_icmp_header_init (p);
496
497 p->checksum.type = PG_EDIT_UNSPECIFIED;
498
499 {
500 icmp46_header_t tmp;
501
Dave Barachd7cb1b52016-12-09 09:52:16 -0500502 if (!unformat (input, "ICMP %U", unformat_icmp_type_and_code, &tmp))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700503 goto error;
504
505 pg_edit_set_fixed (&p->type, tmp.type);
506 pg_edit_set_fixed (&p->code, tmp.code);
507 }
508
509 /* Parse options. */
510 while (1)
511 {
512 if (unformat (input, "checksum %U",
Dave Barachd7cb1b52016-12-09 09:52:16 -0500513 unformat_pg_edit, unformat_pg_number, &p->checksum))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700514 ;
515
516 /* Can't parse input: try next protocol level. */
517 else
518 break;
519 }
520
Dave Barachd7cb1b52016-12-09 09:52:16 -0500521 if (!unformat_user (input, unformat_pg_payload, s))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700522 goto error;
523
524 if (p->checksum.type == PG_EDIT_UNSPECIFIED)
525 {
Dave Barachd7cb1b52016-12-09 09:52:16 -0500526 pg_edit_group_t *g = pg_stream_get_group (s, group_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700527 g->edit_function = icmp4_pg_edit_function;
528 g->edit_function_opaque = 0;
529 }
530
531 return 1;
532
Dave Barachd7cb1b52016-12-09 09:52:16 -0500533error:
Ed Warnickecb9cada2015-12-08 15:45:58 -0700534 /* Free up any edits we may have added. */
535 pg_free_edit_group (s);
536 return 0;
537}
538
Dave Barachd7cb1b52016-12-09 09:52:16 -0500539void
540ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type, u32 node_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700541{
Dave Barachd7cb1b52016-12-09 09:52:16 -0500542 icmp4_main_t *im = &icmp4_main;
Dave Barach34716fa2019-05-23 12:38:22 -0400543 u32 old_next_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700544
Dave Barachd7cb1b52016-12-09 09:52:16 -0500545 ASSERT ((int) type < ARRAY_LEN (im->ip4_input_next_index_by_type));
Dave Barach34716fa2019-05-23 12:38:22 -0400546 old_next_index = im->ip4_input_next_index_by_type[type];
547
Ed Warnickecb9cada2015-12-08 15:45:58 -0700548 im->ip4_input_next_index_by_type[type]
549 = vlib_node_add_next (vm, ip4_icmp_input_node.index, node_index);
Dave Barach34716fa2019-05-23 12:38:22 -0400550
551 if (old_next_index &&
552 (old_next_index != im->ip4_input_next_index_by_type[type]))
553 clib_warning ("WARNING: changed next_by_type[%d]", (int) type);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700554}
555
556static clib_error_t *
557icmp4_init (vlib_main_t * vm)
558{
Dave Barachd7cb1b52016-12-09 09:52:16 -0500559 ip_main_t *im = &ip_main;
560 ip_protocol_info_t *pi;
561 icmp4_main_t *cm = &icmp4_main;
562 clib_error_t *error;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700563
564 error = vlib_call_init_function (vm, ip_main_init);
565
566 if (error)
567 return error;
568
569 pi = ip_get_protocol_info (im, IP_PROTOCOL_ICMP);
570 pi->format_header = format_ip4_icmp_header;
571 pi->unformat_pg_edit = unformat_pg_icmp_header;
572
573 cm->type_by_name = hash_create_string (0, sizeof (uword));
574#define _(n,t) hash_set_mem (cm->type_by_name, #t, (n));
575 foreach_icmp4_type;
576#undef _
577
578 cm->type_and_code_by_name = hash_create_string (0, sizeof (uword));
579#define _(a,n,t) hash_set_mem (cm->type_by_name, #t, (n) | (ICMP4_##a << 8));
580 foreach_icmp4_code;
581#undef _
582
Dave Barachb7b92992018-10-17 10:38:51 -0400583 clib_memset (cm->ip4_input_next_index_by_type,
584 ICMP_INPUT_NEXT_ERROR,
585 sizeof (cm->ip4_input_next_index_by_type));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700586
Neale Ranns5c6dd172022-02-17 09:08:47 +0000587 vlib_thread_main_t *tm = &vlib_thread_main;
588 u32 n_vlib_mains = tm->n_vlib_mains;
589
Ole Troan816b5d62023-04-24 16:02:44 +0200590 throttle_init (&icmp_throttle, n_vlib_mains, THROTTLE_BITS, 1e-5);
Neale Ranns5c6dd172022-02-17 09:08:47 +0000591
Ed Warnickecb9cada2015-12-08 15:45:58 -0700592 return 0;
593}
594
595VLIB_INIT_FUNCTION (icmp4_init);
Dave Barachd7cb1b52016-12-09 09:52:16 -0500596
597/*
598 * fd.io coding-style-patch-verification: ON
599 *
600 * Local Variables:
601 * eval: (c-set-style "gnu")
602 * End:
603 */