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>
44 static char *icmp_error_strings[] = {
51 format_ip4_icmp_type_and_code (u8 * s, va_list * args)
53 icmp4_type_t type = va_arg (*args, int);
54 u8 code = va_arg (*args, int);
57 #define _(n,f) case n: t = #f; break;
70 return format (s, "unknown 0x%x", type);
72 s = format (s, "%s", t);
75 switch ((type << 8) | code)
77 #define _(a,n,f) case (ICMP4_##a << 8) | (n): t = #f; break;
85 s = format (s, " %s", t);
91 format_ip4_icmp_header (u8 * s, va_list * args)
93 icmp46_header_t *icmp = va_arg (*args, icmp46_header_t *);
94 u32 max_header_bytes = va_arg (*args, u32);
97 if (max_header_bytes < sizeof (icmp[0]))
98 return format (s, "ICMP header truncated");
100 s = format (s, "ICMP %U checksum 0x%x",
101 format_ip4_icmp_type_and_code, icmp->type, icmp->code,
102 clib_net_to_host_u16 (icmp->checksum));
108 format_icmp_input_trace (u8 * s, va_list * va)
110 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
111 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
112 icmp_input_trace_t *t = va_arg (*va, icmp_input_trace_t *);
115 format_ip4_header, t->packet_data, sizeof (t->packet_data));
122 ICMP_INPUT_NEXT_ERROR,
128 uword *type_and_code_by_name;
132 /* Vector dispatch table indexed by [icmp type]. */
133 u8 ip4_input_next_index_by_type[256];
136 icmp4_main_t icmp4_main;
139 ip4_icmp_input (vlib_main_t * vm,
140 vlib_node_runtime_t * node, vlib_frame_t * frame)
142 icmp4_main_t *im = &icmp4_main;
143 uword n_packets = frame->n_vectors;
145 u32 n_left_from, n_left_to_next, next;
147 from = vlib_frame_vector_args (frame);
148 n_left_from = n_packets;
149 next = node->cached_next_index;
151 if (node->flags & VLIB_NODE_FLAG_TRACE)
152 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
154 sizeof (icmp_input_trace_t));
156 while (n_left_from > 0)
158 vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
160 while (n_left_from > 0 && n_left_to_next > 0)
164 icmp46_header_t *icmp0;
168 if (PREDICT_TRUE (n_left_from > 2))
170 vlib_prefetch_buffer_with_index (vm, from[2], LOAD);
171 p0 = vlib_get_buffer (vm, from[1]);
172 ip0 = vlib_buffer_get_current (p0);
173 CLIB_PREFETCH (ip0, CLIB_CACHE_LINE_BYTES, LOAD);
176 bi0 = to_next[0] = from[0];
183 p0 = vlib_get_buffer (vm, bi0);
184 ip0 = vlib_buffer_get_current (p0);
185 icmp0 = ip4_next_header (ip0);
187 next0 = im->ip4_input_next_index_by_type[type0];
189 p0->error = node->errors[ICMP4_ERROR_UNKNOWN_TYPE];
191 /* Verify speculative enqueue, maybe switch current next frame */
192 vlib_validate_buffer_enqueue_x1 (vm, node, next, to_next,
193 n_left_to_next, bi0, next0);
196 vlib_put_next_frame (vm, node, next, n_left_to_next);
199 return frame->n_vectors;
203 VLIB_REGISTER_NODE (ip4_icmp_input_node,static) = {
204 .function = ip4_icmp_input,
205 .name = "ip4-icmp-input",
207 .vector_size = sizeof (u32),
209 .format_trace = format_icmp_input_trace,
211 .n_errors = ARRAY_LEN (icmp_error_strings),
212 .error_strings = icmp_error_strings,
216 [ICMP_INPUT_NEXT_ERROR] = "ip4-punt",
222 ip4_icmp_echo_request (vlib_main_t * vm,
223 vlib_node_runtime_t * node, vlib_frame_t * frame)
225 uword n_packets = frame->n_vectors;
227 u32 n_left_from, n_left_to_next, next;
228 ip4_main_t *i4m = &ip4_main;
229 u16 *fragment_ids, *fid;
230 u8 host_config_ttl = i4m->host_config.ttl;
232 from = vlib_frame_vector_args (frame);
233 n_left_from = n_packets;
234 next = node->cached_next_index;
236 if (node->flags & VLIB_NODE_FLAG_TRACE)
237 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
239 sizeof (icmp_input_trace_t));
241 /* Get random fragment IDs for replies. */
242 fid = fragment_ids = clib_random_buffer_get_data (&vm->random_buffer,
244 sizeof (fragment_ids[0]));
246 while (n_left_from > 0)
248 vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
250 while (n_left_from > 2 && n_left_to_next > 2)
252 vlib_buffer_t *p0, *p1;
253 ip4_header_t *ip0, *ip1;
254 icmp46_header_t *icmp0, *icmp1;
257 ip_csum_t sum0, sum1;
259 bi0 = to_next[0] = from[0];
260 bi1 = to_next[1] = from[1];
267 p0 = vlib_get_buffer (vm, bi0);
268 p1 = vlib_get_buffer (vm, bi1);
269 ip0 = vlib_buffer_get_current (p0);
270 ip1 = vlib_buffer_get_current (p1);
271 icmp0 = ip4_next_header (ip0);
272 icmp1 = ip4_next_header (ip1);
274 vnet_buffer (p0)->sw_if_index[VLIB_RX] =
275 vnet_main.local_interface_sw_if_index;
276 vnet_buffer (p1)->sw_if_index[VLIB_RX] =
277 vnet_main.local_interface_sw_if_index;
279 /* Update ICMP checksum. */
280 sum0 = icmp0->checksum;
281 sum1 = icmp1->checksum;
283 ASSERT (icmp0->type == ICMP4_echo_request);
284 ASSERT (icmp1->type == ICMP4_echo_request);
285 sum0 = ip_csum_update (sum0, ICMP4_echo_request, ICMP4_echo_reply,
286 icmp46_header_t, type);
287 sum1 = ip_csum_update (sum1, ICMP4_echo_request, ICMP4_echo_reply,
288 icmp46_header_t, type);
289 icmp0->type = ICMP4_echo_reply;
290 icmp1->type = ICMP4_echo_reply;
292 icmp0->checksum = ip_csum_fold (sum0);
293 icmp1->checksum = ip_csum_fold (sum1);
295 src0 = ip0->src_address.data_u32;
296 src1 = ip1->src_address.data_u32;
297 dst0 = ip0->dst_address.data_u32;
298 dst1 = ip1->dst_address.data_u32;
300 /* Swap source and destination address.
301 Does not change checksum. */
302 ip0->src_address.data_u32 = dst0;
303 ip1->src_address.data_u32 = dst1;
304 ip0->dst_address.data_u32 = src0;
305 ip1->dst_address.data_u32 = src1;
307 /* Update IP checksum. */
308 sum0 = ip0->checksum;
309 sum1 = ip1->checksum;
311 sum0 = ip_csum_update (sum0, ip0->ttl, host_config_ttl,
313 sum1 = ip_csum_update (sum1, ip1->ttl, host_config_ttl,
315 ip0->ttl = host_config_ttl;
316 ip1->ttl = host_config_ttl;
318 /* New fragment id. */
319 sum0 = ip_csum_update (sum0, ip0->fragment_id, fid[0],
320 ip4_header_t, fragment_id);
321 sum1 = ip_csum_update (sum1, ip1->fragment_id, fid[1],
322 ip4_header_t, fragment_id);
323 ip0->fragment_id = fid[0];
324 ip1->fragment_id = fid[1];
327 ip0->checksum = ip_csum_fold (sum0);
328 ip1->checksum = ip_csum_fold (sum1);
330 ASSERT (ip0->checksum == ip4_header_checksum (ip0));
331 ASSERT (ip1->checksum == ip4_header_checksum (ip1));
333 p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
334 p1->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
337 while (n_left_from > 0 && n_left_to_next > 0)
341 icmp46_header_t *icmp0;
345 bi0 = to_next[0] = from[0];
352 p0 = vlib_get_buffer (vm, bi0);
353 ip0 = vlib_buffer_get_current (p0);
354 icmp0 = ip4_next_header (ip0);
356 vnet_buffer (p0)->sw_if_index[VLIB_RX] =
357 vnet_main.local_interface_sw_if_index;
359 /* Update ICMP checksum. */
360 sum0 = icmp0->checksum;
362 ASSERT (icmp0->type == ICMP4_echo_request);
363 sum0 = ip_csum_update (sum0, ICMP4_echo_request, ICMP4_echo_reply,
364 icmp46_header_t, type);
365 icmp0->type = ICMP4_echo_reply;
366 icmp0->checksum = ip_csum_fold (sum0);
368 src0 = ip0->src_address.data_u32;
369 dst0 = ip0->dst_address.data_u32;
370 ip0->src_address.data_u32 = dst0;
371 ip0->dst_address.data_u32 = src0;
373 /* Update IP checksum. */
374 sum0 = ip0->checksum;
376 sum0 = ip_csum_update (sum0, ip0->ttl, host_config_ttl,
378 ip0->ttl = host_config_ttl;
380 sum0 = ip_csum_update (sum0, ip0->fragment_id, fid[0],
381 ip4_header_t, fragment_id);
382 ip0->fragment_id = fid[0];
385 ip0->checksum = ip_csum_fold (sum0);
387 ASSERT (ip0->checksum == ip4_header_checksum (ip0));
389 p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
392 vlib_put_next_frame (vm, node, next, n_left_to_next);
395 vlib_error_count (vm, ip4_icmp_input_node.index,
396 ICMP4_ERROR_ECHO_REPLIES_SENT, frame->n_vectors);
398 return frame->n_vectors;
402 VLIB_REGISTER_NODE (ip4_icmp_echo_request_node,static) = {
403 .function = ip4_icmp_echo_request,
404 .name = "ip4-icmp-echo-request",
406 .vector_size = sizeof (u32),
408 .format_trace = format_icmp_input_trace,
412 [0] = "ip4-load-balance",
419 IP4_ICMP_ERROR_NEXT_DROP,
420 IP4_ICMP_ERROR_NEXT_LOOKUP,
421 IP4_ICMP_ERROR_N_NEXT,
422 } ip4_icmp_error_next_t;
425 icmp4_icmp_type_to_error (u8 type)
429 case ICMP4_destination_unreachable:
430 return ICMP4_ERROR_DEST_UNREACH_SENT;
431 case ICMP4_time_exceeded:
432 return ICMP4_ERROR_TTL_EXPIRE_SENT;
433 case ICMP4_parameter_problem:
434 return ICMP4_ERROR_PARAM_PROBLEM_SENT;
436 return ICMP4_ERROR_DROP;
441 ip4_icmp_error (vlib_main_t * vm,
442 vlib_node_runtime_t * node, vlib_frame_t * frame)
445 uword n_left_from, n_left_to_next;
446 ip4_icmp_error_next_t next_index;
447 ip4_main_t *im = &ip4_main;
448 ip_lookup_main_t *lm = &im->lookup_main;
450 from = vlib_frame_vector_args (frame);
451 n_left_from = frame->n_vectors;
452 next_index = node->cached_next_index;
454 if (node->flags & VLIB_NODE_FLAG_TRACE)
455 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
457 sizeof (icmp_input_trace_t));
459 while (n_left_from > 0)
461 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
463 while (n_left_from > 0 && n_left_to_next > 0)
466 * Duplicate first buffer and free the original chain. Keep
467 * as much of the original packet as possible, within the
468 * minimum MTU. We chat "a little" here by keeping whatever
469 * is available in the first buffer.
473 u32 org_pi0 = from[0];
474 u32 next0 = IP4_ICMP_ERROR_NEXT_LOOKUP;
475 u8 error0 = ICMP4_ERROR_NONE;
476 vlib_buffer_t *p0, *org_p0;
477 ip4_header_t *ip0, *out_ip0;
478 icmp46_header_t *icmp0;
479 u32 sw_if_index0, if_add_index0;
482 org_p0 = vlib_get_buffer (vm, org_pi0);
483 p0 = vlib_buffer_copy_no_chain (vm, org_p0, &pi0);
484 if (!p0 || pi0 == ~0) /* Out of buffers */
487 /* Speculatively enqueue p0 to the current next frame */
494 ip0 = vlib_buffer_get_current (p0);
495 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
497 /* Add IP header and ICMPv4 header including a 4 byte data field */
498 vlib_buffer_advance (p0,
499 -sizeof (ip4_header_t) -
500 sizeof (icmp46_header_t) - 4);
503 p0->current_length > 576 ? 576 : p0->current_length;
504 out_ip0 = vlib_buffer_get_current (p0);
505 icmp0 = (icmp46_header_t *) & out_ip0[1];
507 /* Fill ip header fields */
508 out_ip0->ip_version_and_header_length = 0x45;
510 out_ip0->length = clib_host_to_net_u16 (p0->current_length);
511 out_ip0->fragment_id = 0;
512 out_ip0->flags_and_fragment_offset = 0;
514 out_ip0->protocol = IP_PROTOCOL_ICMP;
515 out_ip0->dst_address = ip0->src_address;
517 if (PREDICT_TRUE (vec_len (lm->if_address_pool_index_by_sw_if_index)
520 lm->if_address_pool_index_by_sw_if_index[sw_if_index0];
521 if (PREDICT_TRUE (if_add_index0 != ~0))
523 ip_interface_address_t *if_add =
524 pool_elt_at_index (lm->if_address_pool, if_add_index0);
525 ip4_address_t *if_ip =
526 ip_interface_address_get_address (lm, if_add);
527 out_ip0->src_address = *if_ip;
531 /* interface has no IP4 address - should not happen */
532 next0 = IP4_ICMP_ERROR_NEXT_DROP;
533 error0 = ICMP4_ERROR_DROP;
535 out_ip0->checksum = ip4_header_checksum (out_ip0);
537 /* Fill icmp header fields */
538 icmp0->type = vnet_buffer (p0)->ip.icmp.type;
539 icmp0->code = vnet_buffer (p0)->ip.icmp.code;
540 *((u32 *) (icmp0 + 1)) =
541 clib_host_to_net_u32 (vnet_buffer (p0)->ip.icmp.data);
544 ip_incremental_checksum (0, icmp0,
546 sizeof (ip4_header_t));
547 icmp0->checksum = ~ip_csum_fold (sum);
549 /* Update error status */
550 if (error0 == ICMP4_ERROR_NONE)
551 error0 = icmp4_icmp_type_to_error (icmp0->type);
553 vlib_error_count (vm, node->node_index, error0, 1);
555 /* Verify speculative enqueue, maybe switch current next frame */
556 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
557 to_next, n_left_to_next,
560 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
564 * push the original buffers to error-drop, so that
565 * they can get the error counters handled, then freed
567 vlib_buffer_enqueue_to_single_next (vm, node,
568 vlib_frame_vector_args (frame),
569 IP4_ICMP_ERROR_NEXT_DROP,
572 return frame->n_vectors;
576 VLIB_REGISTER_NODE (ip4_icmp_error_node) = {
577 .function = ip4_icmp_error,
578 .name = "ip4-icmp-error",
579 .vector_size = sizeof (u32),
581 .n_errors = ARRAY_LEN (icmp_error_strings),
582 .error_strings = icmp_error_strings,
584 .n_next_nodes = IP4_ICMP_ERROR_N_NEXT,
586 [IP4_ICMP_ERROR_NEXT_DROP] = "ip4-drop",
587 [IP4_ICMP_ERROR_NEXT_LOOKUP] = "ip4-lookup",
590 .format_trace = format_icmp_input_trace,
596 unformat_icmp_type_and_code (unformat_input_t * input, va_list * args)
598 icmp46_header_t *h = va_arg (*args, icmp46_header_t *);
599 icmp4_main_t *cm = &icmp4_main;
602 if (unformat_user (input, unformat_vlib_number_by_name,
603 cm->type_and_code_by_name, &i))
605 h->type = (i >> 8) & 0xff;
606 h->code = (i >> 0) & 0xff;
608 else if (unformat_user (input, unformat_vlib_number_by_name,
609 cm->type_by_name, &i))
621 icmp4_pg_edit_function (pg_main_t * pg,
623 pg_edit_group_t * g, u32 * packets, u32 n_packets)
625 vlib_main_t *vm = vlib_get_main ();
626 u32 ip_offset, icmp_offset;
628 icmp_offset = g->start_byte_offset;
629 ip_offset = (g - 1)->start_byte_offset;
631 while (n_packets >= 1)
635 icmp46_header_t *icmp0;
638 p0 = vlib_get_buffer (vm, packets[0]);
642 ASSERT (p0->current_data == 0);
643 ip0 = (void *) (p0->data + ip_offset);
644 icmp0 = (void *) (p0->data + icmp_offset);
646 /* if IP length has been specified, then calculate the length based on buffer */
647 if (ip0->length == 0)
648 len0 = vlib_buffer_length_in_chain (vm, p0) - icmp_offset;
650 len0 = clib_net_to_host_u16 (ip0->length) - icmp_offset;
653 ~ip_csum_fold (ip_incremental_checksum (0, icmp0, len0));
659 pg_edit_t type, code;
661 } pg_icmp46_header_t;
664 pg_icmp_header_init (pg_icmp46_header_t * p)
666 /* Initialize fields that are not bit fields in the IP header. */
667 #define _(f) pg_edit_init (&p->f, icmp46_header_t, f);
675 unformat_pg_icmp_header (unformat_input_t * input, va_list * args)
677 pg_stream_t *s = va_arg (*args, pg_stream_t *);
678 pg_icmp46_header_t *p;
681 p = pg_create_edit_group (s, sizeof (p[0]), sizeof (icmp46_header_t),
683 pg_icmp_header_init (p);
685 p->checksum.type = PG_EDIT_UNSPECIFIED;
690 if (!unformat (input, "ICMP %U", unformat_icmp_type_and_code, &tmp))
693 pg_edit_set_fixed (&p->type, tmp.type);
694 pg_edit_set_fixed (&p->code, tmp.code);
700 if (unformat (input, "checksum %U",
701 unformat_pg_edit, unformat_pg_number, &p->checksum))
704 /* Can't parse input: try next protocol level. */
709 if (!unformat_user (input, unformat_pg_payload, s))
712 if (p->checksum.type == PG_EDIT_UNSPECIFIED)
714 pg_edit_group_t *g = pg_stream_get_group (s, group_index);
715 g->edit_function = icmp4_pg_edit_function;
716 g->edit_function_opaque = 0;
722 /* Free up any edits we may have added. */
723 pg_free_edit_group (s);
728 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type, u32 node_index)
730 icmp4_main_t *im = &icmp4_main;
733 ASSERT ((int) type < ARRAY_LEN (im->ip4_input_next_index_by_type));
734 old_next_index = im->ip4_input_next_index_by_type[type];
736 im->ip4_input_next_index_by_type[type]
737 = vlib_node_add_next (vm, ip4_icmp_input_node.index, node_index);
739 if (old_next_index &&
740 (old_next_index != im->ip4_input_next_index_by_type[type]))
741 clib_warning ("WARNING: changed next_by_type[%d]", (int) type);
744 static clib_error_t *
745 icmp4_init (vlib_main_t * vm)
747 ip_main_t *im = &ip_main;
748 ip_protocol_info_t *pi;
749 icmp4_main_t *cm = &icmp4_main;
752 error = vlib_call_init_function (vm, ip_main_init);
757 pi = ip_get_protocol_info (im, IP_PROTOCOL_ICMP);
758 pi->format_header = format_ip4_icmp_header;
759 pi->unformat_pg_edit = unformat_pg_icmp_header;
761 cm->type_by_name = hash_create_string (0, sizeof (uword));
762 #define _(n,t) hash_set_mem (cm->type_by_name, #t, (n));
766 cm->type_and_code_by_name = hash_create_string (0, sizeof (uword));
767 #define _(a,n,t) hash_set_mem (cm->type_by_name, #t, (n) | (ICMP4_##a << 8));
771 clib_memset (cm->ip4_input_next_index_by_type,
772 ICMP_INPUT_NEXT_ERROR,
773 sizeof (cm->ip4_input_next_index_by_type));
775 ip4_icmp_register_type (vm, ICMP4_echo_request,
776 ip4_icmp_echo_request_node.index);
781 VLIB_INIT_FUNCTION (icmp4_init);
784 * fd.io coding-style-patch-verification: ON
787 * eval: (c-set-style "gnu")