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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * ip/icmp4.c: ipv4 icmp
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #include <vlib/vlib.h>
41 #include <vnet/ip/ip.h>
42 #include <vnet/pg/pg.h>
43 #include <vnet/ip/ip_sas.h>
44 #include <vnet/util/throttle.h>
46 /** ICMP throttling */
47 static throttle_t icmp_throttle;
50 format_ip4_icmp_type_and_code (u8 * s, va_list * args)
52 icmp4_type_t type = va_arg (*args, int);
53 u8 code = va_arg (*args, int);
56 #define _(n,f) case n: t = #f; break;
69 return format (s, "unknown 0x%x", type);
71 s = format (s, "%s", t);
74 switch ((type << 8) | code)
76 #define _(a,n,f) case (ICMP4_##a << 8) | (n): t = #f; break;
84 s = format (s, " %s", t);
90 format_ip4_icmp_header (u8 * s, va_list * args)
92 icmp46_header_t *icmp = va_arg (*args, icmp46_header_t *);
93 u32 max_header_bytes = va_arg (*args, u32);
96 if (max_header_bytes < sizeof (icmp[0]))
97 return format (s, "ICMP header truncated");
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));
103 if ((ICMP4_echo_request == icmp->type || ICMP4_echo_reply == icmp->type)
104 && sizeof (icmp[0]) + sizeof (u16) < max_header_bytes)
106 s = format (s, " id %u", clib_net_to_host_u16 (*(u16 *) (icmp + 1)));
113 format_icmp_input_trace (u8 * s, va_list * va)
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 *);
117 icmp_input_trace_t *t = va_arg (*va, icmp_input_trace_t *);
120 format_ip4_header, t->packet_data, sizeof (t->packet_data));
127 ICMP_INPUT_NEXT_ERROR,
133 uword *type_and_code_by_name;
137 /* Vector dispatch table indexed by [icmp type]. */
138 u8 ip4_input_next_index_by_type[256];
141 icmp4_main_t icmp4_main;
144 ip4_icmp_input (vlib_main_t * vm,
145 vlib_node_runtime_t * node, vlib_frame_t * frame)
147 icmp4_main_t *im = &icmp4_main;
148 uword n_packets = frame->n_vectors;
150 u32 n_left_from, n_left_to_next, next;
152 from = vlib_frame_vector_args (frame);
153 n_left_from = n_packets;
154 next = node->cached_next_index;
156 if (node->flags & VLIB_NODE_FLAG_TRACE)
157 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
159 sizeof (icmp_input_trace_t));
161 while (n_left_from > 0)
163 vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
165 while (n_left_from > 0 && n_left_to_next > 0)
169 icmp46_header_t *icmp0;
173 if (PREDICT_TRUE (n_left_from > 2))
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);
178 clib_prefetch_load (ip0);
181 bi0 = to_next[0] = from[0];
188 p0 = vlib_get_buffer (vm, bi0);
189 ip0 = vlib_buffer_get_current (p0);
190 icmp0 = ip4_next_header (ip0);
192 next0 = im->ip4_input_next_index_by_type[type0];
194 p0->error = node->errors[ICMP4_ERROR_UNKNOWN_TYPE];
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);
201 vlib_put_next_frame (vm, node, next, n_left_to_next);
204 return frame->n_vectors;
207 VLIB_REGISTER_NODE (ip4_icmp_input_node) = {
208 .function = ip4_icmp_input,
209 .name = "ip4-icmp-input",
211 .vector_size = sizeof (u32),
213 .format_trace = format_icmp_input_trace,
215 .n_errors = ICMP4_N_ERROR,
216 .error_counters = icmp4_error_counters,
220 [ICMP_INPUT_NEXT_ERROR] = "ip4-punt",
226 IP4_ICMP_ERROR_NEXT_DROP,
227 IP4_ICMP_ERROR_NEXT_LOOKUP,
228 IP4_ICMP_ERROR_N_NEXT,
229 } ip4_icmp_error_next_t;
232 icmp4_icmp_type_to_error (u8 type)
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;
243 return ICMP4_ERROR_DROP;
248 ip4_icmp_error (vlib_main_t * vm,
249 vlib_node_runtime_t * node, vlib_frame_t * frame)
252 uword n_left_from, n_left_to_next;
253 ip4_icmp_error_next_t next_index;
254 u32 thread_index = vm->thread_index;
256 from = vlib_frame_vector_args (frame);
257 n_left_from = frame->n_vectors;
258 next_index = node->cached_next_index;
260 u64 seed = throttle_seed (&icmp_throttle, thread_index, vlib_time_now (vm));
262 if (node->flags & VLIB_NODE_FLAG_TRACE)
263 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
265 sizeof (icmp_input_trace_t));
267 while (n_left_from > 0)
269 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
271 while (n_left_from > 0 && n_left_to_next > 0)
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.
281 u32 org_pi0 = from[0];
282 u32 next0 = IP4_ICMP_ERROR_NEXT_LOOKUP;
283 u8 error0 = ICMP4_ERROR_NONE;
284 vlib_buffer_t *p0, *org_p0;
285 ip4_header_t *ip0, *out_ip0;
286 icmp46_header_t *icmp0;
290 org_p0 = vlib_get_buffer (vm, org_pi0);
291 ip0 = vlib_buffer_get_current (org_p0);
293 /* Rate limit based on the src,dst addresses in the original packet
296 (u64) ip0->dst_address.as_u32 << 32 | ip0->src_address.as_u32;
298 if (throttle_check (&icmp_throttle, thread_index, r0, seed))
300 vlib_error_count (vm, node->node_index, ICMP4_ERROR_DROP, 1);
306 p0 = vlib_buffer_copy_no_chain (vm, org_p0, &pi0);
307 if (!p0 || pi0 == ~0) /* Out of buffers */
310 /* Speculatively enqueue p0 to the current next frame */
317 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
319 vlib_buffer_copy_trace_flag (vm, org_p0, pi0);
321 /* 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);
326 p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
328 p0->current_length > 576 ? 576 : p0->current_length;
329 out_ip0 = vlib_buffer_get_current (p0);
330 icmp0 = (icmp46_header_t *) & out_ip0[1];
332 /* Fill ip header fields */
333 out_ip0->ip_version_and_header_length = 0x45;
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;
339 out_ip0->protocol = IP_PROTOCOL_ICMP;
340 out_ip0->dst_address = ip0->src_address;
341 /* 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))
344 { /* interface has no IP6 address - should not happen */
345 next0 = IP4_ICMP_ERROR_NEXT_DROP;
346 error0 = ICMP4_ERROR_DROP;
349 out_ip0->checksum = ip4_header_checksum (out_ip0);
351 /* 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);
358 ip_incremental_checksum (0, icmp0,
360 sizeof (ip4_header_t));
361 icmp0->checksum = ~ip_csum_fold (sum);
363 /* Update error status */
364 if (error0 == ICMP4_ERROR_NONE)
365 error0 = icmp4_icmp_type_to_error (icmp0->type);
367 vlib_error_count (vm, node->node_index, error0, 1);
369 /* 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,
374 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
378 * push the original buffers to error-drop, so that
379 * they can get the error counters handled, then freed
381 vlib_buffer_enqueue_to_single_next (vm, node,
382 vlib_frame_vector_args (frame),
383 IP4_ICMP_ERROR_NEXT_DROP,
386 return frame->n_vectors;
389 VLIB_REGISTER_NODE (ip4_icmp_error_node) = {
390 .function = ip4_icmp_error,
391 .name = "ip4-icmp-error",
392 .vector_size = sizeof (u32),
394 .n_errors = ICMP4_N_ERROR,
395 .error_counters = icmp4_error_counters,
397 .n_next_nodes = IP4_ICMP_ERROR_N_NEXT,
399 [IP4_ICMP_ERROR_NEXT_DROP] = "ip4-drop",
400 [IP4_ICMP_ERROR_NEXT_LOOKUP] = "ip4-lookup",
403 .format_trace = format_icmp_input_trace,
408 unformat_icmp_type_and_code (unformat_input_t * input, va_list * args)
410 icmp46_header_t *h = va_arg (*args, icmp46_header_t *);
411 icmp4_main_t *cm = &icmp4_main;
414 if (unformat_user (input, unformat_vlib_number_by_name,
415 cm->type_and_code_by_name, &i))
417 h->type = (i >> 8) & 0xff;
418 h->code = (i >> 0) & 0xff;
420 else if (unformat_user (input, unformat_vlib_number_by_name,
421 cm->type_by_name, &i))
433 icmp4_pg_edit_function (pg_main_t * pg,
435 pg_edit_group_t * g, u32 * packets, u32 n_packets)
437 vlib_main_t *vm = vlib_get_main ();
438 u32 ip_offset, icmp_offset;
440 icmp_offset = g->start_byte_offset;
441 ip_offset = (g - 1)->start_byte_offset;
443 while (n_packets >= 1)
447 icmp46_header_t *icmp0;
450 p0 = vlib_get_buffer (vm, packets[0]);
454 ASSERT (p0->current_data == 0);
455 ip0 = (void *) (p0->data + ip_offset);
456 icmp0 = (void *) (p0->data + icmp_offset);
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;
462 len0 = clib_net_to_host_u16 (ip0->length) - icmp_offset;
465 ~ip_csum_fold (ip_incremental_checksum (0, icmp0, len0));
471 pg_edit_t type, code;
473 } pg_icmp46_header_t;
476 pg_icmp_header_init (pg_icmp46_header_t * p)
478 /* Initialize fields that are not bit fields in the IP header. */
479 #define _(f) pg_edit_init (&p->f, icmp46_header_t, f);
487 unformat_pg_icmp_header (unformat_input_t * input, va_list * args)
489 pg_stream_t *s = va_arg (*args, pg_stream_t *);
490 pg_icmp46_header_t *p;
493 p = pg_create_edit_group (s, sizeof (p[0]), sizeof (icmp46_header_t),
495 pg_icmp_header_init (p);
497 p->checksum.type = PG_EDIT_UNSPECIFIED;
502 if (!unformat (input, "ICMP %U", unformat_icmp_type_and_code, &tmp))
505 pg_edit_set_fixed (&p->type, tmp.type);
506 pg_edit_set_fixed (&p->code, tmp.code);
512 if (unformat (input, "checksum %U",
513 unformat_pg_edit, unformat_pg_number, &p->checksum))
516 /* Can't parse input: try next protocol level. */
521 if (!unformat_user (input, unformat_pg_payload, s))
524 if (p->checksum.type == PG_EDIT_UNSPECIFIED)
526 pg_edit_group_t *g = pg_stream_get_group (s, group_index);
527 g->edit_function = icmp4_pg_edit_function;
528 g->edit_function_opaque = 0;
534 /* Free up any edits we may have added. */
535 pg_free_edit_group (s);
540 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type, u32 node_index)
542 icmp4_main_t *im = &icmp4_main;
545 ASSERT ((int) type < ARRAY_LEN (im->ip4_input_next_index_by_type));
546 old_next_index = im->ip4_input_next_index_by_type[type];
548 im->ip4_input_next_index_by_type[type]
549 = vlib_node_add_next (vm, ip4_icmp_input_node.index, node_index);
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);
556 static clib_error_t *
557 icmp4_init (vlib_main_t * vm)
559 ip_main_t *im = &ip_main;
560 ip_protocol_info_t *pi;
561 icmp4_main_t *cm = &icmp4_main;
564 error = vlib_call_init_function (vm, ip_main_init);
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;
573 cm->type_by_name = hash_create_string (0, sizeof (uword));
574 #define _(n,t) hash_set_mem (cm->type_by_name, #t, (n));
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));
583 clib_memset (cm->ip4_input_next_index_by_type,
584 ICMP_INPUT_NEXT_ERROR,
585 sizeof (cm->ip4_input_next_index_by_type));
587 vlib_thread_main_t *tm = &vlib_thread_main;
588 u32 n_vlib_mains = tm->n_vlib_mains;
590 throttle_init (&icmp_throttle, n_vlib_mains, THROTTLE_BITS, 1e-5);
595 VLIB_INIT_FUNCTION (icmp4_init);
598 * fd.io coding-style-patch-verification: ON
601 * eval: (c-set-style "gnu")