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) = {
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",
223 IP4_ICMP_ERROR_NEXT_DROP,
224 IP4_ICMP_ERROR_NEXT_LOOKUP,
225 IP4_ICMP_ERROR_N_NEXT,
226 } ip4_icmp_error_next_t;
229 icmp4_icmp_type_to_error (u8 type)
233 case ICMP4_destination_unreachable:
234 return ICMP4_ERROR_DEST_UNREACH_SENT;
235 case ICMP4_time_exceeded:
236 return ICMP4_ERROR_TTL_EXPIRE_SENT;
237 case ICMP4_parameter_problem:
238 return ICMP4_ERROR_PARAM_PROBLEM_SENT;
240 return ICMP4_ERROR_DROP;
245 ip4_icmp_error (vlib_main_t * vm,
246 vlib_node_runtime_t * node, vlib_frame_t * frame)
249 uword n_left_from, n_left_to_next;
250 ip4_icmp_error_next_t next_index;
251 ip4_main_t *im = &ip4_main;
252 ip_lookup_main_t *lm = &im->lookup_main;
254 from = vlib_frame_vector_args (frame);
255 n_left_from = frame->n_vectors;
256 next_index = node->cached_next_index;
258 if (node->flags & VLIB_NODE_FLAG_TRACE)
259 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
261 sizeof (icmp_input_trace_t));
263 while (n_left_from > 0)
265 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
267 while (n_left_from > 0 && n_left_to_next > 0)
270 * Duplicate first buffer and free the original chain. Keep
271 * as much of the original packet as possible, within the
272 * minimum MTU. We chat "a little" here by keeping whatever
273 * is available in the first buffer.
277 u32 org_pi0 = from[0];
278 u32 next0 = IP4_ICMP_ERROR_NEXT_LOOKUP;
279 u8 error0 = ICMP4_ERROR_NONE;
280 vlib_buffer_t *p0, *org_p0;
281 ip4_header_t *ip0, *out_ip0;
282 icmp46_header_t *icmp0;
283 u32 sw_if_index0, if_add_index0;
286 org_p0 = vlib_get_buffer (vm, org_pi0);
287 p0 = vlib_buffer_copy_no_chain (vm, org_p0, &pi0);
288 if (!p0 || pi0 == ~0) /* Out of buffers */
291 /* Speculatively enqueue p0 to the current next frame */
298 ip0 = vlib_buffer_get_current (p0);
299 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
301 /* Add IP header and ICMPv4 header including a 4 byte data field */
302 vlib_buffer_advance (p0,
303 -sizeof (ip4_header_t) -
304 sizeof (icmp46_header_t) - 4);
307 p0->current_length > 576 ? 576 : p0->current_length;
308 out_ip0 = vlib_buffer_get_current (p0);
309 icmp0 = (icmp46_header_t *) & out_ip0[1];
311 /* Fill ip header fields */
312 out_ip0->ip_version_and_header_length = 0x45;
314 out_ip0->length = clib_host_to_net_u16 (p0->current_length);
315 out_ip0->fragment_id = 0;
316 out_ip0->flags_and_fragment_offset = 0;
318 out_ip0->protocol = IP_PROTOCOL_ICMP;
319 out_ip0->dst_address = ip0->src_address;
321 if (PREDICT_TRUE (vec_len (lm->if_address_pool_index_by_sw_if_index)
324 lm->if_address_pool_index_by_sw_if_index[sw_if_index0];
325 if (PREDICT_TRUE (if_add_index0 != ~0))
327 ip_interface_address_t *if_add =
328 pool_elt_at_index (lm->if_address_pool, if_add_index0);
329 ip4_address_t *if_ip =
330 ip_interface_address_get_address (lm, if_add);
331 out_ip0->src_address = *if_ip;
335 /* interface has no IP4 address - should not happen */
336 next0 = IP4_ICMP_ERROR_NEXT_DROP;
337 error0 = ICMP4_ERROR_DROP;
339 out_ip0->checksum = ip4_header_checksum (out_ip0);
341 /* Fill icmp header fields */
342 icmp0->type = vnet_buffer (p0)->ip.icmp.type;
343 icmp0->code = vnet_buffer (p0)->ip.icmp.code;
344 *((u32 *) (icmp0 + 1)) =
345 clib_host_to_net_u32 (vnet_buffer (p0)->ip.icmp.data);
348 ip_incremental_checksum (0, icmp0,
350 sizeof (ip4_header_t));
351 icmp0->checksum = ~ip_csum_fold (sum);
353 /* Update error status */
354 if (error0 == ICMP4_ERROR_NONE)
355 error0 = icmp4_icmp_type_to_error (icmp0->type);
357 vlib_error_count (vm, node->node_index, error0, 1);
359 /* Verify speculative enqueue, maybe switch current next frame */
360 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
361 to_next, n_left_to_next,
364 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
368 * push the original buffers to error-drop, so that
369 * they can get the error counters handled, then freed
371 vlib_buffer_enqueue_to_single_next (vm, node,
372 vlib_frame_vector_args (frame),
373 IP4_ICMP_ERROR_NEXT_DROP,
376 return frame->n_vectors;
380 VLIB_REGISTER_NODE (ip4_icmp_error_node) = {
381 .function = ip4_icmp_error,
382 .name = "ip4-icmp-error",
383 .vector_size = sizeof (u32),
385 .n_errors = ARRAY_LEN (icmp_error_strings),
386 .error_strings = icmp_error_strings,
388 .n_next_nodes = IP4_ICMP_ERROR_N_NEXT,
390 [IP4_ICMP_ERROR_NEXT_DROP] = "ip4-drop",
391 [IP4_ICMP_ERROR_NEXT_LOOKUP] = "ip4-lookup",
394 .format_trace = format_icmp_input_trace,
400 unformat_icmp_type_and_code (unformat_input_t * input, va_list * args)
402 icmp46_header_t *h = va_arg (*args, icmp46_header_t *);
403 icmp4_main_t *cm = &icmp4_main;
406 if (unformat_user (input, unformat_vlib_number_by_name,
407 cm->type_and_code_by_name, &i))
409 h->type = (i >> 8) & 0xff;
410 h->code = (i >> 0) & 0xff;
412 else if (unformat_user (input, unformat_vlib_number_by_name,
413 cm->type_by_name, &i))
425 icmp4_pg_edit_function (pg_main_t * pg,
427 pg_edit_group_t * g, u32 * packets, u32 n_packets)
429 vlib_main_t *vm = vlib_get_main ();
430 u32 ip_offset, icmp_offset;
432 icmp_offset = g->start_byte_offset;
433 ip_offset = (g - 1)->start_byte_offset;
435 while (n_packets >= 1)
439 icmp46_header_t *icmp0;
442 p0 = vlib_get_buffer (vm, packets[0]);
446 ASSERT (p0->current_data == 0);
447 ip0 = (void *) (p0->data + ip_offset);
448 icmp0 = (void *) (p0->data + icmp_offset);
450 /* if IP length has been specified, then calculate the length based on buffer */
451 if (ip0->length == 0)
452 len0 = vlib_buffer_length_in_chain (vm, p0) - icmp_offset;
454 len0 = clib_net_to_host_u16 (ip0->length) - icmp_offset;
457 ~ip_csum_fold (ip_incremental_checksum (0, icmp0, len0));
463 pg_edit_t type, code;
465 } pg_icmp46_header_t;
468 pg_icmp_header_init (pg_icmp46_header_t * p)
470 /* Initialize fields that are not bit fields in the IP header. */
471 #define _(f) pg_edit_init (&p->f, icmp46_header_t, f);
479 unformat_pg_icmp_header (unformat_input_t * input, va_list * args)
481 pg_stream_t *s = va_arg (*args, pg_stream_t *);
482 pg_icmp46_header_t *p;
485 p = pg_create_edit_group (s, sizeof (p[0]), sizeof (icmp46_header_t),
487 pg_icmp_header_init (p);
489 p->checksum.type = PG_EDIT_UNSPECIFIED;
494 if (!unformat (input, "ICMP %U", unformat_icmp_type_and_code, &tmp))
497 pg_edit_set_fixed (&p->type, tmp.type);
498 pg_edit_set_fixed (&p->code, tmp.code);
504 if (unformat (input, "checksum %U",
505 unformat_pg_edit, unformat_pg_number, &p->checksum))
508 /* Can't parse input: try next protocol level. */
513 if (!unformat_user (input, unformat_pg_payload, s))
516 if (p->checksum.type == PG_EDIT_UNSPECIFIED)
518 pg_edit_group_t *g = pg_stream_get_group (s, group_index);
519 g->edit_function = icmp4_pg_edit_function;
520 g->edit_function_opaque = 0;
526 /* Free up any edits we may have added. */
527 pg_free_edit_group (s);
532 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type, u32 node_index)
534 icmp4_main_t *im = &icmp4_main;
537 ASSERT ((int) type < ARRAY_LEN (im->ip4_input_next_index_by_type));
538 old_next_index = im->ip4_input_next_index_by_type[type];
540 im->ip4_input_next_index_by_type[type]
541 = vlib_node_add_next (vm, ip4_icmp_input_node.index, node_index);
543 if (old_next_index &&
544 (old_next_index != im->ip4_input_next_index_by_type[type]))
545 clib_warning ("WARNING: changed next_by_type[%d]", (int) type);
548 static clib_error_t *
549 icmp4_init (vlib_main_t * vm)
551 ip_main_t *im = &ip_main;
552 ip_protocol_info_t *pi;
553 icmp4_main_t *cm = &icmp4_main;
556 error = vlib_call_init_function (vm, ip_main_init);
561 pi = ip_get_protocol_info (im, IP_PROTOCOL_ICMP);
562 pi->format_header = format_ip4_icmp_header;
563 pi->unformat_pg_edit = unformat_pg_icmp_header;
565 cm->type_by_name = hash_create_string (0, sizeof (uword));
566 #define _(n,t) hash_set_mem (cm->type_by_name, #t, (n));
570 cm->type_and_code_by_name = hash_create_string (0, sizeof (uword));
571 #define _(a,n,t) hash_set_mem (cm->type_by_name, #t, (n) | (ICMP4_##a << 8));
575 clib_memset (cm->ip4_input_next_index_by_type,
576 ICMP_INPUT_NEXT_ERROR,
577 sizeof (cm->ip4_input_next_index_by_type));
582 VLIB_INIT_FUNCTION (icmp4_init);
585 * fd.io coding-style-patch-verification: ON
588 * eval: (c-set-style "gnu")