2 * Copyright (c) 2016 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.
18 #include <vlib/vlib.h>
19 #include <vlib/unix/unix.h>
20 #include <vnet/fib/ip6_fib.h>
21 #include <vnet/fib/ip4_fib.h>
22 #include <vnet/ip/ip_sas.h>
23 #include <vnet/ip/ip6_link.h>
24 #include <vnet/ip/ip6_ll_table.h>
25 #include <vnet/plugin/plugin.h>
26 #include <vpp/app/version.h>
28 #include <vnet/ip/icmp4.h>
29 #include <ping/ping.h>
31 ping_main_t ping_main;
35 * @brief IPv4 and IPv6 ICMP Ping.
37 * This file contains code to support IPv4 or IPv6 ICMP ECHO_REQUEST to
52 format_icmp_echo_trace (u8 * s, va_list * va)
54 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
55 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
56 icmp_echo_trace_t *t = va_arg (*va, icmp_echo_trace_t *);
59 format (s, "ICMP%s echo id %d seq %d", t->is_ip6 ? "6" : "4", t->id,
61 if (t->cli_process_node == PING_CLI_UNKNOWN_NODE)
63 s = format (s, " (unknown)");
67 s = format (s, " send to cli node %d", t->cli_process_node);
75 format_ip46_ping_result (u8 * s, va_list * args)
77 send_ip46_ping_result_t res = va_arg (*args, send_ip46_ping_result_t);
81 #define _(v, n) case SEND_PING_##v: s = format(s, "%s", n);break;
82 foreach_ip46_ping_result
91 * Poor man's get-set-clear functions
92 * for manipulation of icmp_id -> cli_process_id
95 * There should normally be very few (0..1..2) of these
96 * mappings, so the linear search is a good strategy.
98 * Make them thread-safe via a simple spinlock.
103 static_always_inline uword
104 get_cli_process_id_by_icmp_id_mt (vlib_main_t * vm, u16 icmp_id)
106 ping_main_t *pm = &ping_main;
107 uword cli_process_id = PING_CLI_UNKNOWN_NODE;
110 clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
111 vec_foreach (pr, pm->active_ping_runs)
113 if (pr->icmp_id == icmp_id)
115 cli_process_id = pr->cli_process_id;
119 clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
120 return cli_process_id;
124 static_always_inline void
125 set_cli_process_id_by_icmp_id_mt (vlib_main_t * vm, u16 icmp_id,
126 uword cli_process_id)
128 ping_main_t *pm = &ping_main;
131 clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
132 vec_foreach (pr, pm->active_ping_runs)
134 if (pr->icmp_id == icmp_id)
136 pr->cli_process_id = cli_process_id;
137 goto have_found_and_set;
140 /* no such key yet - add a new one */
141 ping_run_t new_pr = {.icmp_id = icmp_id,.cli_process_id = cli_process_id };
142 vec_add1 (pm->active_ping_runs, new_pr);
144 clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
148 static_always_inline void
149 clear_cli_process_id_by_icmp_id_mt (vlib_main_t * vm, u16 icmp_id)
151 ping_main_t *pm = &ping_main;
154 clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
155 vec_foreach (pr, pm->active_ping_runs)
157 if (pr->icmp_id == icmp_id)
159 vec_del1 (pm->active_ping_runs, pm->active_ping_runs - pr);
163 clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
166 static_always_inline int
167 ip46_get_icmp_id_and_seq (vlib_main_t * vm, vlib_buffer_t * b0,
168 u16 * out_icmp_id, u16 * out_icmp_seq, int is_ip6)
173 ip6_header_t *ip6 = vlib_buffer_get_current (b0);
174 if (ip6->protocol != IP_PROTOCOL_ICMP6)
178 l4_offset = sizeof (*ip6); // IPv6 EH
182 ip4_header_t *ip4 = vlib_buffer_get_current (b0);
183 l4_offset = ip4_header_bytes (ip4);
186 icmp46_header_t *icmp46 = vlib_buffer_get_current (b0) + l4_offset;
187 icmp46_echo_request_t *icmp46_echo = (icmp46_echo_request_t *) (icmp46 + 1);
189 *out_icmp_id = clib_net_to_host_u16 (icmp46_echo->id);
190 *out_icmp_seq = clib_net_to_host_u16 (icmp46_echo->seq);
195 * post the buffer to a given cli process node - the caller should forget bi0 after return.
198 static_always_inline void
199 ip46_post_icmp_reply_event (vlib_main_t * vm, uword cli_process_id, u32 bi0,
202 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
203 u64 nowts = clib_cpu_time_now ();
205 /* Pass the timestamp to the cli_process thanks to the vnet_buffer unused metadata field */
207 /* Camping on unused data... just ensure statically that there is enough space */
208 STATIC_ASSERT (ARRAY_LEN (vnet_buffer (b0)->unused) *
209 sizeof (vnet_buffer (b0)->unused[0]) > sizeof (nowts),
210 "ping reply timestamp fits within remaining space of vnet_buffer unused data");
211 u64 *pnowts = (void *) &vnet_buffer (b0)->unused[0];
214 u32 event_id = is_ip6 ? PING_RESPONSE_IP6 : PING_RESPONSE_IP4;
215 vlib_process_signal_event_mt (vm, cli_process_id, event_id, bi0);
219 static_always_inline void
220 ip46_echo_reply_maybe_trace_buffer (vlib_main_t * vm,
221 vlib_node_runtime_t * node,
222 uword cli_process_id, u16 id, u16 seq,
223 vlib_buffer_t * b0, int is_ip6)
225 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
227 icmp_echo_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
230 tr->cli_process_node = cli_process_id;
236 static_always_inline uword
237 ip46_icmp_echo_reply_inner_node_fn (vlib_main_t * vm,
238 vlib_node_runtime_t * node,
239 vlib_frame_t * frame, int do_trace,
242 u32 n_left_from, *from, *to_next;
243 icmp46_echo_reply_next_t next_index;
245 from = vlib_frame_vector_args (frame);
246 n_left_from = frame->n_vectors;
248 next_index = node->cached_next_index;
250 while (n_left_from > 0)
253 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
255 while (n_left_from > 0 && n_left_to_next > 0)
260 * The buffers (replies) are either posted to the CLI thread
261 * awaiting for them for subsequent analysis and disposal,
262 * or are sent to the punt node.
264 * So the only "next" node is a punt, normally.
266 u32 next0 = ICMP46_ECHO_REPLY_NEXT_PUNT;
269 b0 = vlib_get_buffer (vm, bi0);
275 uword cli_process_id = PING_CLI_UNKNOWN_NODE;
277 if (ip46_get_icmp_id_and_seq (vm, b0, &icmp_id, &icmp_seq, is_ip6))
279 cli_process_id = get_cli_process_id_by_icmp_id_mt (vm, icmp_id);
283 ip46_echo_reply_maybe_trace_buffer (vm, node, cli_process_id,
284 icmp_id, icmp_seq, b0,
287 if (~0 == cli_process_id)
289 /* no outstanding requests for this reply, punt */
290 /* speculatively enqueue b0 to the current next frame */
294 /* verify speculative enqueue, maybe switch current next frame */
295 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
296 to_next, n_left_to_next,
301 /* Post the buffer to CLI thread. It will take care of freeing it. */
302 ip46_post_icmp_reply_event (vm, cli_process_id, bi0, is_ip6);
305 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
307 return frame->n_vectors;
311 * select "with-trace" or "without-trace" codepaths upfront.
313 static_always_inline uword
314 ip46_icmp_echo_reply_outer_node_fn (vlib_main_t * vm,
315 vlib_node_runtime_t * node,
316 vlib_frame_t * frame, int is_ip6)
318 if (node->flags & VLIB_NODE_FLAG_TRACE)
319 return ip46_icmp_echo_reply_inner_node_fn (vm, node, frame,
320 1 /* do_trace */ , is_ip6);
322 return ip46_icmp_echo_reply_inner_node_fn (vm, node, frame,
323 0 /* do_trace */ , is_ip6);
327 ip4_icmp_echo_reply_node_fn (vlib_main_t * vm,
328 vlib_node_runtime_t * node, vlib_frame_t * frame)
330 return ip46_icmp_echo_reply_outer_node_fn (vm, node, frame,
335 ip6_icmp_echo_reply_node_fn (vlib_main_t * vm,
336 vlib_node_runtime_t * node, vlib_frame_t * frame)
338 return ip46_icmp_echo_reply_outer_node_fn (vm, node, frame,
343 VLIB_REGISTER_NODE (ip6_icmp_echo_reply_node, static) =
345 .function = ip6_icmp_echo_reply_node_fn,
346 .name = "ip6-icmp-echo-reply",
347 .vector_size = sizeof (u32),
348 .format_trace = format_icmp_echo_trace,
349 .n_next_nodes = ICMP46_ECHO_REPLY_N_NEXT,
351 [ICMP46_ECHO_REPLY_NEXT_DROP] = "ip6-drop",
352 [ICMP46_ECHO_REPLY_NEXT_PUNT] = "ip6-punt",
356 VLIB_REGISTER_NODE (ip4_icmp_echo_reply_node, static) =
358 .function = ip4_icmp_echo_reply_node_fn,
359 .name = "ip4-icmp-echo-reply",
360 .vector_size = sizeof (u32),
361 .format_trace = format_icmp_echo_trace,
362 .n_next_nodes = ICMP46_ECHO_REPLY_N_NEXT,
364 [ICMP46_ECHO_REPLY_NEXT_DROP] = "ip4-drop",
365 [ICMP46_ECHO_REPLY_NEXT_PUNT] = "ip4-punt",
371 ip4_icmp_echo_request (vlib_main_t * vm,
372 vlib_node_runtime_t * node, vlib_frame_t * frame)
374 uword n_packets = frame->n_vectors;
376 u32 n_left_from, n_left_to_next, next;
377 ip4_main_t *i4m = &ip4_main;
378 u16 *fragment_ids, *fid;
379 u8 host_config_ttl = i4m->host_config.ttl;
381 from = vlib_frame_vector_args (frame);
382 n_left_from = n_packets;
383 next = node->cached_next_index;
385 if (node->flags & VLIB_NODE_FLAG_TRACE)
386 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
388 sizeof (icmp_input_trace_t));
390 /* Get random fragment IDs for replies. */
391 fid = fragment_ids = clib_random_buffer_get_data (&vm->random_buffer,
393 sizeof (fragment_ids[0]));
395 while (n_left_from > 0)
397 vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
399 while (n_left_from > 2 && n_left_to_next > 2)
401 vlib_buffer_t *p0, *p1;
402 ip4_header_t *ip0, *ip1;
403 icmp46_header_t *icmp0, *icmp1;
406 ip_csum_t sum0, sum1;
408 bi0 = to_next[0] = from[0];
409 bi1 = to_next[1] = from[1];
416 p0 = vlib_get_buffer (vm, bi0);
417 p1 = vlib_get_buffer (vm, bi1);
418 ip0 = vlib_buffer_get_current (p0);
419 ip1 = vlib_buffer_get_current (p1);
420 icmp0 = ip4_next_header (ip0);
421 icmp1 = ip4_next_header (ip1);
423 vnet_buffer (p0)->sw_if_index[VLIB_RX] =
424 vnet_main.local_interface_sw_if_index;
425 vnet_buffer (p1)->sw_if_index[VLIB_RX] =
426 vnet_main.local_interface_sw_if_index;
428 /* Update ICMP checksum. */
429 sum0 = icmp0->checksum;
430 sum1 = icmp1->checksum;
432 ASSERT (icmp0->type == ICMP4_echo_request);
433 ASSERT (icmp1->type == ICMP4_echo_request);
434 sum0 = ip_csum_update (sum0, ICMP4_echo_request, ICMP4_echo_reply,
435 icmp46_header_t, type);
436 sum1 = ip_csum_update (sum1, ICMP4_echo_request, ICMP4_echo_reply,
437 icmp46_header_t, type);
438 icmp0->type = ICMP4_echo_reply;
439 icmp1->type = ICMP4_echo_reply;
441 icmp0->checksum = ip_csum_fold (sum0);
442 icmp1->checksum = ip_csum_fold (sum1);
444 src0 = ip0->src_address.data_u32;
445 src1 = ip1->src_address.data_u32;
446 dst0 = ip0->dst_address.data_u32;
447 dst1 = ip1->dst_address.data_u32;
449 /* Swap source and destination address.
450 Does not change checksum. */
451 ip0->src_address.data_u32 = dst0;
452 ip1->src_address.data_u32 = dst1;
453 ip0->dst_address.data_u32 = src0;
454 ip1->dst_address.data_u32 = src1;
456 /* Update IP checksum. */
457 sum0 = ip0->checksum;
458 sum1 = ip1->checksum;
460 sum0 = ip_csum_update (sum0, ip0->ttl, host_config_ttl,
462 sum1 = ip_csum_update (sum1, ip1->ttl, host_config_ttl,
464 ip0->ttl = host_config_ttl;
465 ip1->ttl = host_config_ttl;
467 /* New fragment id. */
468 sum0 = ip_csum_update (sum0, ip0->fragment_id, fid[0],
469 ip4_header_t, fragment_id);
470 sum1 = ip_csum_update (sum1, ip1->fragment_id, fid[1],
471 ip4_header_t, fragment_id);
472 ip0->fragment_id = fid[0];
473 ip1->fragment_id = fid[1];
476 ip0->checksum = ip_csum_fold (sum0);
477 ip1->checksum = ip_csum_fold (sum1);
479 ASSERT (ip4_header_checksum_is_valid (ip0));
480 ASSERT (ip4_header_checksum_is_valid (ip1));
482 p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
483 p1->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
486 while (n_left_from > 0 && n_left_to_next > 0)
490 icmp46_header_t *icmp0;
494 bi0 = to_next[0] = from[0];
501 p0 = vlib_get_buffer (vm, bi0);
502 ip0 = vlib_buffer_get_current (p0);
503 icmp0 = ip4_next_header (ip0);
505 vnet_buffer (p0)->sw_if_index[VLIB_RX] =
506 vnet_main.local_interface_sw_if_index;
508 /* Update ICMP checksum. */
509 sum0 = icmp0->checksum;
511 ASSERT (icmp0->type == ICMP4_echo_request);
512 sum0 = ip_csum_update (sum0, ICMP4_echo_request, ICMP4_echo_reply,
513 icmp46_header_t, type);
514 icmp0->type = ICMP4_echo_reply;
515 icmp0->checksum = ip_csum_fold (sum0);
517 src0 = ip0->src_address.data_u32;
518 dst0 = ip0->dst_address.data_u32;
519 ip0->src_address.data_u32 = dst0;
520 ip0->dst_address.data_u32 = src0;
522 /* Update IP checksum. */
523 sum0 = ip0->checksum;
525 sum0 = ip_csum_update (sum0, ip0->ttl, host_config_ttl,
527 ip0->ttl = host_config_ttl;
529 sum0 = ip_csum_update (sum0, ip0->fragment_id, fid[0],
530 ip4_header_t, fragment_id);
531 ip0->fragment_id = fid[0];
534 ip0->checksum = ip_csum_fold (sum0);
536 ASSERT (ip4_header_checksum_is_valid (ip0));
538 p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
541 vlib_put_next_frame (vm, node, next, n_left_to_next);
544 vlib_error_count (vm, ip4_icmp_input_node.index,
545 ICMP4_ERROR_ECHO_REPLIES_SENT, frame->n_vectors);
547 return frame->n_vectors;
551 format_icmp_input_trace (u8 * s, va_list * va)
553 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
554 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
555 icmp_input_trace_t *t = va_arg (*va, icmp_input_trace_t *);
558 format_ip4_header, t->packet_data, sizeof (t->packet_data));
564 VLIB_REGISTER_NODE (ip4_icmp_echo_request_node,static) = {
565 .function = ip4_icmp_echo_request,
566 .name = "ip4-icmp-echo-request",
568 .vector_size = sizeof (u32),
570 .format_trace = format_icmp_input_trace,
574 [0] = "ip4-load-balance",
580 * A swarm of address-family agnostic helper functions
581 * for building and sending the ICMP echo request.
583 * Deliberately mostly "static" rather than "static inline"
584 * so one can trace them sanely if needed in debugger, if needed.
588 static_always_inline u8
589 get_icmp_echo_payload_byte (int offset)
591 return (offset % 256);
594 /* Fill in the ICMP ECHO structure, return the safety-checked and possibly shrunk data_len */
596 init_icmp46_echo_request (vlib_main_t * vm, vlib_buffer_t * b0,
597 int l4_header_offset,
598 icmp46_echo_request_t * icmp46_echo, u16 seq_host,
599 u16 id_host, u64 now, u16 data_len)
605 l4_header_offset + sizeof (icmp46_header_t) +
606 offsetof (icmp46_echo_request_t, data);
607 int max_data_len = vlib_buffer_get_default_data_size (vm) - l34_len;
609 int first_buf_data_len = data_len < max_data_len ? data_len : max_data_len;
611 int payload_offset = 0;
612 for (i = 0; i < first_buf_data_len; i++)
613 icmp46_echo->data[i] = get_icmp_echo_payload_byte (payload_offset++);
615 /* inspired by vlib_buffer_add_data */
616 vlib_buffer_t *hb = b0;
617 int remaining_data_len = data_len - first_buf_data_len;
618 while (remaining_data_len)
620 int this_buf_data_len =
622 vlib_buffer_get_default_data_size (vm) ? remaining_data_len :
623 vlib_buffer_get_default_data_size (vm);
624 int n_alloc = vlib_buffer_alloc (vm, &b0->next_buffer, 1);
627 /* That is how much we have so far - return it... */
628 return (data_len - remaining_data_len);
630 b0->flags |= VLIB_BUFFER_NEXT_PRESENT;
631 /* move on to the newly acquired buffer */
632 b0 = vlib_get_buffer (vm, b0->next_buffer);
633 /* initialize the data */
634 for (i = 0; i < this_buf_data_len; i++)
636 b0->data[i] = get_icmp_echo_payload_byte (payload_offset++);
638 b0->current_length = this_buf_data_len;
639 b0->current_data = 0;
640 remaining_data_len -= this_buf_data_len;
642 hb->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
643 hb->current_length = l34_len + first_buf_data_len;
644 hb->total_length_not_including_first_buffer = data_len - first_buf_data_len;
646 icmp46_echo->time_sent = now;
647 icmp46_echo->seq = clib_host_to_net_u16 (seq_host);
648 icmp46_echo->id = clib_host_to_net_u16 (id_host);
654 ip46_fib_index_from_table_id (u32 table_id, int is_ip6)
656 u32 fib_index = is_ip6 ?
657 ip6_fib_index_from_table_id (table_id) :
658 ip4_fib_index_from_table_id (table_id);
662 static fib_node_index_t
663 ip46_fib_table_lookup_host (u32 fib_index, ip46_address_t * pa46, int is_ip6)
665 fib_node_index_t fib_entry_index = is_ip6 ?
666 ip6_fib_table_lookup (fib_index, &pa46->ip6, 128) :
667 ip4_fib_table_lookup (ip4_fib_get (fib_index), &pa46->ip4, 32);
668 return fib_entry_index;
672 ip46_get_resolving_interface (u32 fib_index, ip46_address_t * pa46,
675 u32 sw_if_index = ~0;
678 fib_node_index_t fib_entry_index;
679 fib_entry_index = ip46_fib_table_lookup_host (fib_index, pa46, is_ip6);
680 sw_if_index = fib_entry_get_resolving_interface (fib_entry_index);
686 ip46_fib_table_get_index_for_sw_if_index (u32 sw_if_index, int is_ip6,
687 ip46_address_t *pa46)
691 if (ip6_address_is_link_local_unicast (&pa46->ip6))
692 return ip6_ll_fib_get (sw_if_index);
693 return ip6_fib_table_get_index_for_sw_if_index (sw_if_index);
695 return ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
700 ip46_fill_l3_header (ip46_address_t * pa46, vlib_buffer_t * b0, int is_ip6)
704 ip6_header_t *ip6 = vlib_buffer_get_current (b0);
705 /* Fill in ip6 header fields */
706 ip6->ip_version_traffic_class_and_flow_label =
707 clib_host_to_net_u32 (0x6 << 28);
708 ip6->payload_length = 0; /* will be set later */
709 ip6->protocol = IP_PROTOCOL_ICMP6;
710 ip6->hop_limit = 255;
711 ip6->dst_address = pa46->ip6;
712 ip6->src_address = pa46->ip6;
713 return (sizeof (ip6_header_t));
717 ip4_header_t *ip4 = vlib_buffer_get_current (b0);
718 /* Fill in ip4 header fields */
720 ip4->ip_version_and_header_length = 0x45;
722 ip4->length = 0; /* will be set later */
723 ip4->fragment_id = 0;
724 ip4->flags_and_fragment_offset = 0;
726 ip4->protocol = IP_PROTOCOL_ICMP;
727 ip4->src_address = pa46->ip4;
728 ip4->dst_address = pa46->ip4;
729 return (sizeof (ip4_header_t));
734 ip46_set_src_address (u32 sw_if_index, vlib_buffer_t * b0, int is_ip6)
740 ip6_header_t *ip6 = vlib_buffer_get_current (b0);
742 res = ip6_sas_by_sw_if_index (sw_if_index, &ip6->dst_address,
747 ip4_header_t *ip4 = vlib_buffer_get_current (b0);
749 res = ip4_sas_by_sw_if_index (sw_if_index, &ip4->dst_address,
756 ip46_print_buffer_src_address (vlib_main_t * vm, vlib_buffer_t * b0,
759 void *format_addr_func;
763 ip6_header_t *ip6 = vlib_buffer_get_current (b0);
764 format_addr_func = format_ip6_address;
765 paddr = &ip6->src_address;
769 ip4_header_t *ip4 = vlib_buffer_get_current (b0);
770 format_addr_func = format_ip4_address;
771 paddr = &ip4->src_address;
773 vlib_cli_output (vm, "Source address: %U ", format_addr_func, paddr);
777 ip46_fill_icmp_request_at (vlib_main_t * vm, int l4_offset, u16 seq_host,
778 u16 id_host, u16 data_len, vlib_buffer_t * b0,
781 icmp46_header_t *icmp46 = vlib_buffer_get_current (b0) + l4_offset;
783 icmp46->type = is_ip6 ? ICMP6_echo_request : ICMP4_echo_request;
785 icmp46->checksum = 0;
787 icmp46_echo_request_t *icmp46_echo = (icmp46_echo_request_t *) (icmp46 + 1);
790 init_icmp46_echo_request (vm, b0, l4_offset, icmp46_echo, seq_host,
791 id_host, clib_cpu_time_now (), data_len);
796 /* Compute ICMP4 checksum with multibuffer support. */
798 ip4_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
802 u32 ip_header_length, payload_length_host_byte_order;
803 u32 n_this_buffer, n_bytes_left, n_ip_bytes_this_buffer;
805 void *data_this_buffer;
807 ip_header_length = ip4_header_bytes (ip0);
808 payload_length_host_byte_order =
809 clib_net_to_host_u16 (ip0->length) - ip_header_length;
811 /* ICMP4 checksum does not include the IP header */
814 n_bytes_left = n_this_buffer = payload_length_host_byte_order;
815 data_this_buffer = (void *) ip0 + ip_header_length;
816 n_ip_bytes_this_buffer =
817 p0->current_length - (((u8 *) ip0 - p0->data) - p0->current_data);
818 if (n_this_buffer + ip_header_length > n_ip_bytes_this_buffer)
820 n_this_buffer = n_ip_bytes_this_buffer > ip_header_length ?
821 n_ip_bytes_this_buffer - ip_header_length : 0;
825 sum0 = ip_incremental_checksum (sum0, data_this_buffer, n_this_buffer);
826 n_bytes_left -= n_this_buffer;
827 if (n_bytes_left == 0)
830 ASSERT (p0->flags & VLIB_BUFFER_NEXT_PRESENT);
831 p0 = vlib_get_buffer (vm, p0->next_buffer);
832 data_this_buffer = vlib_buffer_get_current (p0);
833 n_this_buffer = p0->current_length;
836 sum16 = ~ip_csum_fold (sum0);
843 ip46_fix_len_and_csum (vlib_main_t * vm, int l4_offset, u16 data_len,
844 vlib_buffer_t * b0, int is_ip6)
847 data_len + sizeof (icmp46_header_t) + offsetof (icmp46_echo_request_t,
849 u16 total_length = payload_length + l4_offset;
850 icmp46_header_t *icmp46 = vlib_buffer_get_current (b0) + l4_offset;
851 icmp46->checksum = 0;
855 ip6_header_t *ip6 = vlib_buffer_get_current (b0);
856 ip6->payload_length = clib_host_to_net_u16 (payload_length);
858 int bogus_length = 0;
860 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6, &bogus_length);
864 ip4_header_t *ip4 = vlib_buffer_get_current (b0);
865 ip4->length = clib_host_to_net_u16 (total_length);
867 ip4->checksum = ip4_header_checksum (ip4);
868 icmp46->checksum = ip4_icmp_compute_checksum (vm, b0, ip4);
873 at_most_a_frame (u32 count)
875 return count > VLIB_FRAME_SIZE ? VLIB_FRAME_SIZE : count;
879 ip46_enqueue_packet (vlib_main_t *vm, vlib_buffer_t *b0, u32 burst,
880 u32 lookup_node_index)
888 * Enqueue the packet, possibly as one or more frames of copies to make
889 * bursts. We enqueue b0 as the very last buffer, when there is no possibility
890 * for error in vlib_buffer_copy, so as to allow the caller to free it
891 * in case we encounter the error in the middle of the loop.
893 for (n_to_send = at_most_a_frame (burst), burst -= n_to_send; n_to_send > 0;
894 n_to_send = at_most_a_frame (burst), burst -= n_to_send)
896 f = vlib_get_frame_to_node (vm, lookup_node_index);
897 /* f can not be NULL here - frame allocation failure causes panic */
899 u32 *to_next = vlib_frame_vector_args (f);
900 f->n_vectors = n_to_send;
902 while (n_to_send > 1)
904 vlib_buffer_t *b0copy = vlib_buffer_copy (vm, b0);
905 if (PREDICT_FALSE (b0copy == NULL))
907 *to_next++ = vlib_get_buffer_index (vm, b0copy);
912 /* n_to_send is guaranteed to equal 1 here */
915 /* not the last burst, so still make a copy for the last buffer */
916 vlib_buffer_t *b0copy = vlib_buffer_copy (vm, b0);
917 if (PREDICT_FALSE (b0copy == NULL))
920 *to_next++ = vlib_get_buffer_index (vm, b0copy);
924 /* put the original buffer as the last one of an error-free run */
925 *to_next++ = vlib_get_buffer_index (vm, b0);
927 vlib_put_frame_to_node (vm, lookup_node_index, f);
928 n_sent += f->n_vectors;
932 * We reach here in case we already enqueued one or more buffers
933 * and maybe one or more frames but could not make more copies.
934 * There is an outstanding frame - so ship it and return.
935 * Caller will have to free the b0 in this case, since
936 * we did not enqueue it here yet.
939 ASSERT (n_to_send <= f->n_vectors);
940 f->n_vectors -= n_to_send;
941 n_sent += f->n_vectors;
942 vlib_put_frame_to_node (vm, lookup_node_index, f);
948 * An address-family agnostic ping send function.
951 #define ERROR_OUT(e) do { err = e; goto done; } while (0)
953 static send_ip46_ping_result_t
954 send_ip46_ping (vlib_main_t * vm,
956 ip46_address_t * pa46,
958 u16 seq_host, u16 id_host, u16 data_len, u32 burst,
959 u8 verbose, int is_ip6)
961 int err = SEND_PING_OK;
966 n_buf0 = vlib_buffer_alloc (vm, &bi0, 1);
968 ERROR_OUT (SEND_PING_ALLOC_FAIL);
970 b0 = vlib_get_buffer (vm, bi0);
973 * if the user did not provide a source interface,
974 * perform a resolution and use an interface
975 * via which it succeeds.
978 if (~0 == sw_if_index)
980 fib_index = ip46_fib_index_from_table_id (table_id, is_ip6);
981 sw_if_index = ip46_get_resolving_interface (fib_index, pa46, is_ip6);
985 ip46_fib_table_get_index_for_sw_if_index (sw_if_index, is_ip6, pa46);
988 ERROR_OUT (SEND_PING_NO_TABLE);
989 if (~0 == sw_if_index)
990 ERROR_OUT (SEND_PING_NO_INTERFACE);
992 vnet_buffer (b0)->sw_if_index[VLIB_RX] = sw_if_index;
993 vnet_buffer (b0)->sw_if_index[VLIB_TX] = fib_index;
995 int l4_header_offset = ip46_fill_l3_header (pa46, b0, is_ip6);
997 /* set the src address in the buffer */
998 if (!ip46_set_src_address (sw_if_index, b0, is_ip6))
999 ERROR_OUT (SEND_PING_NO_SRC_ADDRESS);
1001 ip46_print_buffer_src_address (vm, b0, is_ip6);
1004 ip46_fill_icmp_request_at (vm, l4_header_offset, seq_host, id_host,
1005 data_len, b0, is_ip6);
1007 ip46_fix_len_and_csum (vm, l4_header_offset, data_len, b0, is_ip6);
1009 u32 node_index = ip6_lookup_node.index;
1012 if (pa46->ip6.as_u32[0] == clib_host_to_net_u32 (0xff020000))
1014 node_index = ip6_rewrite_mcast_node.index;
1015 vnet_buffer (b0)->sw_if_index[VLIB_RX] = sw_if_index;
1016 vnet_buffer (b0)->sw_if_index[VLIB_TX] = sw_if_index;
1017 vnet_buffer (b0)->ip.adj_index[VLIB_TX] =
1018 ip6_link_get_mcast_adj (sw_if_index);
1023 node_index = ip4_lookup_node.index;
1025 int n_sent = ip46_enqueue_packet (vm, b0, burst, node_index);
1027 err = SEND_PING_NO_BUFFERS;
1030 if (err != SEND_PING_OK)
1033 vlib_buffer_free (vm, &bi0, 1);
1038 static send_ip46_ping_result_t
1039 send_ip6_ping (vlib_main_t * vm,
1040 u32 table_id, ip6_address_t * pa6,
1041 u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len,
1042 u32 burst, u8 verbose)
1044 ip46_address_t target;
1046 return send_ip46_ping (vm, table_id, &target, sw_if_index, seq_host,
1047 id_host, data_len, burst, verbose, 1 /* is_ip6 */ );
1050 static send_ip46_ping_result_t
1051 send_ip4_ping (vlib_main_t * vm,
1052 u32 table_id, ip4_address_t * pa4,
1053 u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len,
1054 u32 burst, u8 verbose)
1056 ip46_address_t target;
1057 ip46_address_set_ip4 (&target, pa4);
1058 return send_ip46_ping (vm, table_id, &target, sw_if_index, seq_host,
1059 id_host, data_len, burst, verbose, 0 /* is_ip6 */ );
1063 print_ip46_icmp_reply (vlib_main_t * vm, u32 bi0, int is_ip6)
1065 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
1068 void *format_addr_func;
1073 ip6_header_t *ip6 = vlib_buffer_get_current (b0);
1074 paddr = (void *) &ip6->src_address;
1075 format_addr_func = (void *) format_ip6_address;
1076 ttl = ip6->hop_limit;
1077 l4_offset = sizeof (ip6_header_t); // FIXME - EH processing ?
1078 payload_length = clib_net_to_host_u16 (ip6->payload_length);
1082 ip4_header_t *ip4 = vlib_buffer_get_current (b0);
1083 paddr = (void *) &ip4->src_address;
1084 format_addr_func = (void *) format_ip4_address;
1086 l4_offset = ip4_header_bytes (ip4);
1088 clib_net_to_host_u16 (ip4->length) + ip4_header_bytes (ip4);
1090 icmp46_header_t *icmp = vlib_buffer_get_current (b0) + l4_offset;
1091 icmp46_echo_request_t *icmp_echo = (icmp46_echo_request_t *) (icmp + 1);
1092 u64 *dataplane_ts = (u64 *) & vnet_buffer (b0)->unused[0];
1094 f64 clocks_per_second = ((f64) vm->clib_time.clocks_per_second);
1096 ((f64) (*dataplane_ts - icmp_echo->time_sent)) / clocks_per_second;
1098 vlib_cli_output (vm,
1099 "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
1103 clib_host_to_net_u16 (icmp_echo->seq), ttl, rtt * 1000.0);
1107 * Perform the ping run with the given parameters in the current CLI process.
1108 * Depending on whether pa4 or pa6 is set, runs IPv4 or IPv6 ping.
1109 * The amusing side effect is of course if both are set, then both pings are sent.
1110 * This behavior can be used to ping a dualstack host over IPv4 and IPv6 at once.
1114 run_ping_ip46_address (vlib_main_t * vm, u32 table_id, ip4_address_t * pa4,
1115 ip6_address_t * pa6, u32 sw_if_index,
1116 f64 ping_interval, u32 ping_repeat, u32 data_len,
1117 u32 ping_burst, u32 verbose)
1120 uword curr_proc = vlib_current_process (vm);
1125 static u32 rand_seed = 0;
1127 if (PREDICT_FALSE (!rand_seed))
1128 rand_seed = random_default_seed ();
1130 icmp_id = random_u32 (&rand_seed) & 0xffff;
1132 while (~0 != get_cli_process_id_by_icmp_id_mt (vm, icmp_id))
1134 vlib_cli_output (vm, "ICMP ID collision at %d, incrementing", icmp_id);
1138 set_cli_process_id_by_icmp_id_mt (vm, icmp_id, curr_proc);
1140 for (i = 1; i <= ping_repeat; i++)
1142 send_ip46_ping_result_t res = SEND_PING_OK;
1144 f64 time_ping_sent = vlib_time_now (vm);
1147 res = send_ip6_ping (vm, table_id,
1148 pa6, sw_if_index, i, icmp_id,
1149 data_len, ping_burst, verbose);
1150 if (SEND_PING_OK == res)
1151 n_requests += ping_burst;
1153 vlib_cli_output (vm, "Failed: %U", format_ip46_ping_result, res);
1157 res = send_ip4_ping (vm, table_id, pa4,
1158 sw_if_index, i, icmp_id, data_len,
1159 ping_burst, verbose);
1160 if (SEND_PING_OK == res)
1161 n_requests += ping_burst;
1163 vlib_cli_output (vm, "Failed: %U", format_ip46_ping_result, res);
1166 /* Collect and print the responses until it is time to send a next ping */
1168 while ((i <= ping_repeat)
1171 time_ping_sent + ping_interval - vlib_time_now (vm)) > 0.0))
1173 uword event_type, *event_data = 0;
1174 vlib_process_wait_for_event_or_clock (vm, sleep_interval);
1175 event_type = vlib_process_get_events (vm, &event_data);
1178 case ~0: /* no events => timeout */
1180 case PING_RESPONSE_IP6:
1182 case PING_RESPONSE_IP4:
1185 int is_ip6 = (event_type == PING_RESPONSE_IP6);
1186 for (ii = 0; ii < vec_len (event_data); ii++)
1188 u32 bi0 = event_data[ii];
1189 print_ip46_icmp_reply (vm, bi0, is_ip6);
1192 vlib_buffer_free (vm, &bi0, 1);
1196 case UNIX_CLI_PROCESS_EVENT_READ_READY:
1197 case UNIX_CLI_PROCESS_EVENT_QUIT:
1198 /* someone pressed a key, abort */
1199 vlib_cli_output (vm, "Aborted due to a keypress.");
1202 vec_free (event_data);
1206 vlib_cli_output (vm, "\n");
1210 n_requests) ? 0 : 100.0 * ((float) n_requests -
1211 (float) n_replies) / (float) n_requests;
1212 vlib_cli_output (vm,
1213 "Statistics: %u sent, %u received, %f%% packet loss\n",
1214 n_requests, n_replies, loss);
1215 clear_cli_process_id_by_icmp_id_mt (vm, icmp_id);
1221 static clib_error_t *
1222 ping_ip_address (vlib_main_t * vm,
1223 unformat_input_t * input, vlib_cli_command_t * cmd)
1227 clib_error_t *error = 0;
1228 u32 ping_repeat = 5;
1230 u8 ping_ip4, ping_ip6;
1231 vnet_main_t *vnm = vnet_get_main ();
1232 u32 data_len = PING_DEFAULT_DATA_LEN;
1234 f64 ping_interval = PING_DEFAULT_INTERVAL;
1235 u32 sw_if_index, table_id;
1238 ping_ip4 = ping_ip6 = 0;
1241 if (unformat (input, "%U", unformat_ip4_address, &a4))
1245 else if (unformat (input, "%U", unformat_ip6_address, &a6))
1249 else if (unformat (input, "ipv4"))
1251 if (unformat (input, "%U", unformat_ip4_address, &a4))
1258 clib_error_return (0,
1259 "expecting IPv4 address but got `%U'",
1260 format_unformat_error, input);
1263 else if (unformat (input, "ipv6"))
1265 if (unformat (input, "%U", unformat_ip6_address, &a6))
1272 clib_error_return (0,
1273 "expecting IPv6 address but got `%U'",
1274 format_unformat_error, input);
1280 clib_error_return (0,
1281 "expecting IP4/IP6 address `%U'. Usage: ping <addr> [source <intf>] [size <datasz>] [repeat <count>] [verbose]",
1282 format_unformat_error, input);
1286 /* allow for the second AF in the same ping */
1287 if (!ping_ip4 && (unformat (input, "ipv4")))
1289 if (unformat (input, "%U", unformat_ip4_address, &a4))
1294 else if (!ping_ip6 && (unformat (input, "ipv6")))
1296 if (unformat (input, "%U", unformat_ip6_address, &a6))
1302 /* parse the rest of the parameters in a cycle */
1303 while (!unformat_eof (input, NULL))
1305 if (unformat (input, "source"))
1308 (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1311 clib_error_return (0,
1312 "unknown interface `%U'",
1313 format_unformat_error, input);
1317 else if (unformat (input, "size"))
1319 if (!unformat (input, "%u", &data_len))
1322 clib_error_return (0,
1323 "expecting size but got `%U'",
1324 format_unformat_error, input);
1327 if (data_len > PING_MAXIMUM_DATA_SIZE)
1330 clib_error_return (0,
1331 "%d is bigger than maximum allowed payload size %d",
1332 data_len, PING_MAXIMUM_DATA_SIZE);
1336 else if (unformat (input, "table-id"))
1338 if (!unformat (input, "%u", &table_id))
1341 clib_error_return (0,
1342 "expecting table-id but got `%U'",
1343 format_unformat_error, input);
1347 else if (unformat (input, "interval"))
1349 if (!unformat (input, "%f", &ping_interval))
1352 clib_error_return (0,
1353 "expecting interval (floating point number) got `%U'",
1354 format_unformat_error, input);
1358 else if (unformat (input, "repeat"))
1360 if (!unformat (input, "%u", &ping_repeat))
1363 clib_error_return (0,
1364 "expecting repeat count but got `%U'",
1365 format_unformat_error, input);
1369 else if (unformat (input, "burst"))
1371 if (!unformat (input, "%u", &ping_burst))
1374 clib_error_return (0,
1375 "expecting burst count but got `%U'",
1376 format_unformat_error, input);
1380 else if (unformat (input, "verbose"))
1386 error = clib_error_return (0, "unknown input `%U'",
1387 format_unformat_error, input);
1393 * Operationally, one won't (and shouldn't) need to send more than a frame worth of pings.
1394 * But it may be handy during the debugging.
1398 #define MAX_PING_BURST (10*VLIB_FRAME_SIZE)
1400 #define MAX_PING_BURST (VLIB_FRAME_SIZE)
1403 if (ping_burst < 1 || ping_burst > MAX_PING_BURST)
1404 return clib_error_return (0, "burst size must be between 1 and %u",
1407 run_ping_ip46_address (vm, table_id, ping_ip4 ? &a4 : NULL,
1408 ping_ip6 ? &a6 : NULL, sw_if_index, ping_interval,
1409 ping_repeat, data_len, ping_burst, verbose);
1415 * This command sends an ICMP ECHO_REQUEST to network hosts. The address
1416 * can be an IPv4 or IPv6 address (or both at the same time).
1420 * Example of how ping an IPv4 address:
1421 * @cliexstart{ping 172.16.1.2 source GigabitEthernet2/0/0 repeat 2}
1422 * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1090 ms
1423 * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0914 ms
1425 * Statistics: 2 sent, 2 received, 0% packet loss
1428 * Example of how ping both an IPv4 address and IPv6 address at the same time:
1429 * @cliexstart{ping 172.16.1.2 ipv6 fe80::24a5:f6ff:fe9c:3a36 source GigabitEthernet2/0/0 repeat 2 verbose}
1430 * Adjacency index: 10, sw_if_index: 1
1431 * Adj: ip6-discover-neighbor
1433 * Forced set interface: 1
1434 * Adjacency index: 0, sw_if_index: 4294967295
1437 * Forced set interface: 1
1438 * Source address: 172.16.1.1
1439 * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1899 ms
1440 * Adjacency index: 10, sw_if_index: 1
1441 * Adj: ip6-discover-neighbor
1443 * Forced set interface: 1
1444 * Adjacency index: 0, sw_if_index: 4294967295
1447 * Forced set interface: 1
1448 * Source address: 172.16.1.1
1449 * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0910 ms
1451 * Statistics: 4 sent, 2 received, 50% packet loss
1456 VLIB_CLI_COMMAND (ping_command, static) =
1459 .function = ping_ip_address,
1460 .short_help = "ping {<ip-addr> | ipv4 <ip4-addr> | ipv6 <ip6-addr>}"
1461 " [ipv4 <ip4-addr> | ipv6 <ip6-addr>] [source <interface>]"
1462 " [size <pktsize:60>] [interval <sec:1>] [repeat <cnt:5>] [table-id <id:0>]"
1463 " [burst <count:1>] [verbose]",
1468 static clib_error_t *
1469 ping_cli_init (vlib_main_t * vm)
1471 vlib_thread_main_t *tm = vlib_get_thread_main ();
1472 ping_main_t *pm = &ping_main;
1474 pm->ip6_main = &ip6_main;
1475 pm->ip4_main = &ip4_main;
1476 icmp6_register_type (vm, ICMP6_echo_reply, ip6_icmp_echo_reply_node.index);
1477 ip4_icmp_register_type (vm, ICMP4_echo_reply,
1478 ip4_icmp_echo_reply_node.index);
1479 if (tm->n_vlib_mains > 1)
1480 clib_spinlock_init (&pm->ping_run_check_lock);
1482 ip4_icmp_register_type (vm, ICMP4_echo_request,
1483 ip4_icmp_echo_request_node.index);
1488 VLIB_INIT_FUNCTION (ping_cli_init);
1491 VLIB_PLUGIN_REGISTER () = {
1492 .version = VPP_BUILD_VER,
1493 .description = "Ping (ping)",
1498 * fd.io coding-style-patch-verification: ON
1501 * eval: (c-set-style "gnu")