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.
17 #include <vnet/ip/ping.h>
18 #include <vnet/fib/ip6_fib.h>
19 #include <vnet/fib/ip4_fib.h>
20 #include <vnet/fib/fib_entry.h>
21 #include <vlib/vlib.h>
23 ping_main_t ping_main;
27 * @brief IPv4 and IPv6 ICMP Ping.
29 * This file contains code to suppport IPv4 or IPv6 ICMP ECHO_REQUEST to
36 format_icmp_echo_trace (u8 * s, va_list * va)
38 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
39 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
40 icmp_echo_trace_t *t = va_arg (*va, icmp_echo_trace_t *);
42 s = format (s, "ICMP echo id %d seq %d%s",
43 clib_net_to_host_u16 (t->id),
44 clib_net_to_host_u16 (t->seq), t->bound ? "" : " (unknown)");
50 * If we can find the ping run by an ICMP ID, then we send the signal
51 * to the CLI process referenced by that ping run, alongside with
52 * a freshly made copy of the packet.
53 * I opted for a packet copy to keep the main packet processing path
54 * the same as for all the other nodes.
59 signal_ip46_icmp_reply_event (u8 event_type, vlib_buffer_t * b0)
61 ping_main_t *pm = &ping_main;
67 case PING_RESPONSE_IP4:
69 icmp4_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
70 net_icmp_id = h0->icmp_echo.id;
73 case PING_RESPONSE_IP6:
75 icmp6_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
76 net_icmp_id = h0->icmp_echo.id;
83 uword *p = hash_get (pm->ping_run_by_icmp_id,
84 clib_net_to_host_u16 (net_icmp_id));
88 ping_run_t *pr = vec_elt_at_index (pm->ping_runs, p[0]);
89 vlib_main_t *vm = vlib_mains[pr->cli_thread_index];
90 if (vlib_buffer_alloc (vm, &bi0_copy, 1) == 1)
92 void *dst = vlib_buffer_get_current (vlib_get_buffer (vm,
94 clib_memcpy (dst, vlib_buffer_get_current (b0), b0->current_length);
96 /* If buffer_alloc failed, bi0_copy == 0 - just signaling an event. */
97 f64 nowts = vlib_time_now (vm);
98 /* Pass the timestamp to the cli_process thanks to the vnet_buffer unused metadata field */
99 clib_memcpy (vnet_buffer
101 (vm, bi0_copy))->unused, &nowts, sizeof (nowts));
102 vlib_process_signal_event_mt (vm, pr->cli_process_id, event_type, bi0_copy);
107 * Process ICMPv6 echo replies
110 ip6_icmp_echo_reply_node_fn (vlib_main_t * vm,
111 vlib_node_runtime_t * node, vlib_frame_t * frame)
113 u32 n_left_from, *from;
115 from = vlib_frame_vector_args (frame); /* array of buffer indices */
116 n_left_from = frame->n_vectors; /* number of buffer indices */
118 while (n_left_from > 0)
125 b0 = vlib_get_buffer (vm, bi0);
127 next0 = signal_ip46_icmp_reply_event (PING_RESPONSE_IP6, b0) ?
128 ICMP6_ECHO_REPLY_NEXT_DROP : ICMP6_ECHO_REPLY_NEXT_PUNT;
130 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
132 icmp6_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
133 icmp_echo_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
134 tr->id = h0->icmp_echo.id;
135 tr->seq = h0->icmp_echo.seq;
136 tr->bound = (next0 == ICMP6_ECHO_REPLY_NEXT_DROP);
139 /* push this pkt to the next graph node */
140 vlib_set_next_frame_buffer (vm, node, next0, bi0);
146 return frame->n_vectors;
150 VLIB_REGISTER_NODE (ip6_icmp_echo_reply_node, static) =
152 .function = ip6_icmp_echo_reply_node_fn,
153 .name = "ip6-icmp-echo-reply",
154 .vector_size = sizeof (u32),
155 .format_trace = format_icmp_echo_trace,
156 .n_next_nodes = ICMP6_ECHO_REPLY_N_NEXT,
158 [ICMP6_ECHO_REPLY_NEXT_DROP] = "ip6-drop",
159 [ICMP6_ECHO_REPLY_NEXT_PUNT] = "ip6-punt",
165 * Process ICMPv4 echo replies
168 ip4_icmp_echo_reply_node_fn (vlib_main_t * vm,
169 vlib_node_runtime_t * node, vlib_frame_t * frame)
171 u32 n_left_from, *from;
173 from = vlib_frame_vector_args (frame); /* array of buffer indices */
174 n_left_from = frame->n_vectors; /* number of buffer indices */
176 while (n_left_from > 0)
183 b0 = vlib_get_buffer (vm, bi0);
185 next0 = signal_ip46_icmp_reply_event (PING_RESPONSE_IP4, b0) ?
186 ICMP4_ECHO_REPLY_NEXT_DROP : ICMP4_ECHO_REPLY_NEXT_PUNT;
188 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
190 icmp4_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
191 icmp_echo_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
192 tr->id = h0->icmp_echo.id;
193 tr->seq = h0->icmp_echo.seq;
194 tr->bound = (next0 == ICMP4_ECHO_REPLY_NEXT_DROP);
197 /* push this pkt to the next graph node */
198 vlib_set_next_frame_buffer (vm, node, next0, bi0);
204 return frame->n_vectors;
208 VLIB_REGISTER_NODE (ip4_icmp_echo_reply_node, static) =
210 .function = ip4_icmp_echo_reply_node_fn,
211 .name = "ip4-icmp-echo-reply",
212 .vector_size = sizeof (u32),
213 .format_trace = format_icmp_echo_trace,
214 .n_next_nodes = ICMP4_ECHO_REPLY_N_NEXT,
216 [ICMP4_ECHO_REPLY_NEXT_DROP] = "ip4-drop",
217 [ICMP4_ECHO_REPLY_NEXT_PUNT] = "ip4-punt",
222 char *ip6_lookup_next_nodes[] = IP6_LOOKUP_NEXT_NODES;
223 char *ip4_lookup_next_nodes[] = IP4_LOOKUP_NEXT_NODES;
225 /* Fill in the ICMP ECHO structure, return the safety-checked and possibly shrunk data_len */
227 init_icmp46_echo_request (icmp46_echo_request_t * icmp46_echo,
228 u16 seq_host, u16 id_host, u16 data_len)
231 icmp46_echo->seq = clib_host_to_net_u16 (seq_host);
232 icmp46_echo->id = clib_host_to_net_u16 (id_host);
234 if (data_len > PING_MAXIMUM_DATA_SIZE)
235 data_len = PING_MAXIMUM_DATA_SIZE;
236 for (i = 0; i < data_len; i++)
237 icmp46_echo->data[i] = i % 256;
241 static send_ip46_ping_result_t
242 send_ip6_ping (vlib_main_t * vm, ip6_main_t * im,
243 u32 table_id, ip6_address_t * pa6,
244 u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len,
245 u32 burst, u8 verbose)
247 icmp6_echo_request_header_t *h0;
249 int bogus_length = 0;
253 vlib_buffer_free_list_t *fl;
255 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
256 return SEND_PING_ALLOC_FAIL;
258 p0 = vlib_get_buffer (vm, bi0);
259 fl = vlib_buffer_get_free_list (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
260 vlib_buffer_init_for_free_list (p0, fl);
261 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (p0);
264 * if the user did not provide a source interface, use the any interface
265 * that the destination resolves via.
267 if (~0 == sw_if_index)
269 fib_node_index_t fib_entry_index;
272 fib_index = ip6_fib_index_from_table_id (table_id);
276 vlib_buffer_free (vm, &bi0, 1);
277 return SEND_PING_NO_TABLE;
280 fib_entry_index = ip6_fib_table_lookup (fib_index, pa6, 128);
281 sw_if_index = fib_entry_get_resolving_interface (fib_entry_index);
283 * Set the TX interface to force ip-lookup to use its table ID
285 vnet_buffer (p0)->sw_if_index[VLIB_TX] = fib_index;
290 * force an IP lookup in the table bound to the user's chosen
293 vnet_buffer (p0)->sw_if_index[VLIB_TX] =
294 ip6_fib_table_get_index_for_sw_if_index (sw_if_index);
297 if (~0 == sw_if_index)
299 vlib_buffer_free (vm, &bi0, 1);
300 return SEND_PING_NO_INTERFACE;
303 vnet_buffer (p0)->sw_if_index[VLIB_RX] = sw_if_index;
305 h0 = vlib_buffer_get_current (p0);
307 /* Fill in ip6 header fields */
308 h0->ip6.ip_version_traffic_class_and_flow_label =
309 clib_host_to_net_u32 (0x6 << 28);
310 h0->ip6.payload_length = 0; /* Set below */
311 h0->ip6.protocol = IP_PROTOCOL_ICMP6;
312 h0->ip6.hop_limit = 255;
313 h0->ip6.dst_address = *pa6;
314 h0->ip6.src_address = *pa6;
316 /* Fill in the correct source now */
317 if (!ip6_src_address_for_packet (&im->lookup_main,
319 &h0->ip6.dst_address,
320 &h0->ip6.src_address))
322 vlib_buffer_free (vm, &bi0, 1);
323 return SEND_PING_NO_SRC_ADDRESS;
326 /* Fill in icmp fields */
327 h0->icmp.type = ICMP6_echo_request;
329 h0->icmp.checksum = 0;
332 init_icmp46_echo_request (&h0->icmp_echo, seq_host, id_host, data_len);
333 h0->icmp_echo.time_sent = vlib_time_now (vm);
335 /* Fix up the lengths */
336 h0->ip6.payload_length =
337 clib_host_to_net_u16 (data_len + sizeof (icmp46_header_t));
339 p0->current_length = clib_net_to_host_u16 (h0->ip6.payload_length) +
340 STRUCT_OFFSET_OF (icmp6_echo_request_header_t, icmp);
342 /* Calculate the ICMP checksum */
343 h0->icmp.checksum = 0;
345 ip6_tcp_udp_icmp_compute_checksum (vm, 0, &h0->ip6, &bogus_length);
347 /* Enqueue the packet right now */
348 f = vlib_get_frame_to_node (vm, ip6_lookup_node.index);
349 to_next = vlib_frame_vector_args (f);
352 ASSERT (burst <= VLIB_FRAME_SIZE);
353 f->n_vectors = burst;
356 vlib_buffer_t *c0 = vlib_buffer_copy (vm, p0);
358 to_next[0] = vlib_get_buffer_index (vm, c0);
360 vlib_put_frame_to_node (vm, ip6_lookup_node.index, f);
365 static send_ip46_ping_result_t
366 send_ip4_ping (vlib_main_t * vm,
371 u16 seq_host, u16 id_host, u16 data_len, u32 burst, u8 verbose)
373 icmp4_echo_request_header_t *h0;
375 ip_lookup_main_t *lm = &im->lookup_main;
380 vlib_buffer_free_list_t *fl;
382 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
383 return SEND_PING_ALLOC_FAIL;
385 p0 = vlib_get_buffer (vm, bi0);
386 fl = vlib_buffer_get_free_list (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
387 vlib_buffer_init_for_free_list (p0, fl);
388 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (p0);
391 * if the user did not provide a source interface, use the any interface
392 * that the destination resolves via.
394 if (~0 == sw_if_index)
396 fib_node_index_t fib_entry_index;
399 fib_index = ip4_fib_index_from_table_id (table_id);
403 vlib_buffer_free (vm, &bi0, 1);
404 return SEND_PING_NO_TABLE;
408 ip4_fib_table_lookup (ip4_fib_get (fib_index), pa4, 32);
409 sw_if_index = fib_entry_get_resolving_interface (fib_entry_index);
411 * Set the TX interface to force ip-lookup to use the user's table ID
413 vnet_buffer (p0)->sw_if_index[VLIB_TX] = fib_index;
418 * force an IP lookup in the table bound to the user's chosen
421 vnet_buffer (p0)->sw_if_index[VLIB_TX] =
422 ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
425 if (~0 == sw_if_index)
427 vlib_buffer_free (vm, &bi0, 1);
428 return SEND_PING_NO_INTERFACE;
431 vnet_buffer (p0)->sw_if_index[VLIB_RX] = sw_if_index;
433 h0 = vlib_buffer_get_current (p0);
435 /* Fill in ip4 header fields */
436 h0->ip4.checksum = 0;
437 h0->ip4.ip_version_and_header_length = 0x45;
439 h0->ip4.length = 0; /* Set below */
440 h0->ip4.fragment_id = 0;
441 h0->ip4.flags_and_fragment_offset = 0;
443 h0->ip4.protocol = IP_PROTOCOL_ICMP;
444 h0->ip4.dst_address = *pa4;
445 h0->ip4.src_address = *pa4;
447 /* Fill in the correct source now */
448 if_add_index0 = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
449 if (PREDICT_TRUE (if_add_index0 != ~0))
451 ip_interface_address_t *if_add =
452 pool_elt_at_index (lm->if_address_pool, if_add_index0);
453 ip4_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
454 h0->ip4.src_address = *if_ip;
457 vlib_cli_output (vm, "Source address: %U",
458 format_ip4_address, &h0->ip4.src_address);
462 /* Fill in icmp fields */
463 h0->icmp.type = ICMP4_echo_request;
465 h0->icmp.checksum = 0;
468 init_icmp46_echo_request (&h0->icmp_echo, seq_host, id_host, data_len);
469 h0->icmp_echo.time_sent = vlib_time_now (vm);
471 /* Fix up the lengths */
473 clib_host_to_net_u16 (data_len + sizeof (icmp46_header_t) +
474 sizeof (ip4_header_t));
476 p0->current_length = clib_net_to_host_u16 (h0->ip4.length);
478 /* Calculate the IP and ICMP checksums */
479 h0->ip4.checksum = ip4_header_checksum (&(h0->ip4));
481 ~ip_csum_fold (ip_incremental_checksum (0, &(h0->icmp),
483 sizeof (ip4_header_t)));
485 /* Enqueue the packet right now */
486 f = vlib_get_frame_to_node (vm, ip4_lookup_node.index);
487 to_next = vlib_frame_vector_args (f);
490 ASSERT (burst <= VLIB_FRAME_SIZE);
491 f->n_vectors = burst;
494 vlib_buffer_t *c0 = vlib_buffer_copy (vm, p0);
496 to_next[0] = vlib_get_buffer_index (vm, c0);
498 vlib_put_frame_to_node (vm, ip4_lookup_node.index, f);
505 print_ip6_icmp_reply (vlib_main_t * vm, u32 bi0)
507 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
508 icmp6_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
510 clib_memcpy (&rtt, vnet_buffer (b0)->unused, sizeof (rtt));
511 rtt -= h0->icmp_echo.time_sent;
513 "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
514 clib_host_to_net_u16 (h0->ip6.payload_length),
516 &h0->ip6.src_address,
517 clib_host_to_net_u16 (h0->icmp_echo.seq),
518 h0->ip6.hop_limit, rtt * 1000.0);
522 print_ip4_icmp_reply (vlib_main_t * vm, u32 bi0)
524 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
525 icmp4_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
527 clib_memcpy (&rtt, vnet_buffer (b0)->unused, sizeof (rtt));
528 rtt -= h0->icmp_echo.time_sent;
530 clib_host_to_net_u16 (h0->ip4.length) -
531 (4 * (0xF & h0->ip4.ip_version_and_header_length));
534 "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
537 &h0->ip4.src_address,
538 clib_host_to_net_u16 (h0->icmp_echo.seq),
539 h0->ip4.ttl, rtt * 1000.0);
544 * Perform the ping run with the given parameters in the current CLI process.
545 * Depending on whether pa4 or pa6 is set, runs IPv4 or IPv6 ping.
546 * The amusing side effect is of course if both are set, then both pings are sent.
547 * This behavior can be used to ping a dualstack host over IPv4 and IPv6 at once.
551 run_ping_ip46_address (vlib_main_t * vm, u32 table_id, ip4_address_t * pa4,
552 ip6_address_t * pa6, u32 sw_if_index,
553 f64 ping_interval, u32 ping_repeat, u32 data_len,
554 u32 ping_burst, u32 verbose)
557 ping_main_t *pm = &ping_main;
558 uword curr_proc = vlib_current_process (vm);
562 u32 ping_run_index = 0;
565 static u32 rand_seed = 0;
567 if (PREDICT_FALSE (!rand_seed))
568 rand_seed = random_default_seed ();
570 icmp_id = random_u32 (&rand_seed) & 0xffff;
572 while (hash_get (pm->ping_run_by_icmp_id, icmp_id))
574 vlib_cli_output (vm, "ICMP ID collision at %d, incrementing", icmp_id);
577 pool_get (pm->ping_runs, pr);
578 ping_run_index = pr - pm->ping_runs;
579 pr->cli_process_id = curr_proc;
580 pr->cli_thread_index = vm->thread_index;
581 pr->icmp_id = icmp_id;
582 hash_set (pm->ping_run_by_icmp_id, icmp_id, ping_run_index);
583 for (i = 1; i <= ping_repeat; i++)
586 f64 time_ping_sent = vlib_time_now (vm);
587 /* Reset pr: running ping in other process could have changed pm->ping_runs */
588 pr = vec_elt_at_index (pm->ping_runs, ping_run_index);
592 send_ip6_ping (vm, ping_main.ip6_main, table_id, pa6, sw_if_index,
593 i, icmp_id, data_len, ping_burst, verbose)))
595 n_requests += ping_burst;
599 send_ip4_ping (vm, ping_main.ip4_main, table_id, pa4, sw_if_index,
600 i, icmp_id, data_len, ping_burst, verbose)))
602 n_requests += ping_burst;
604 while ((i <= ping_repeat)
607 time_ping_sent + ping_interval - vlib_time_now (vm)) > 0.0))
609 uword event_type, *event_data = 0;
610 vlib_process_wait_for_event_or_clock (vm, sleep_interval);
611 event_type = vlib_process_get_events (vm, &event_data);
614 case ~0: /* no events => timeout */
616 case PING_RESPONSE_IP6:
619 for (i = 0; i < vec_len (event_data); i++)
621 u32 bi0 = event_data[i];
622 print_ip6_icmp_reply (vm, bi0);
626 vlib_buffer_free (vm, &bi0, 1);
631 case PING_RESPONSE_IP4:
634 for (i = 0; i < vec_len (event_data); i++)
636 u32 bi0 = event_data[i];
637 print_ip4_icmp_reply (vm, bi0);
641 vlib_buffer_free (vm, &bi0, 1);
647 /* someone pressed a key, abort */
648 vlib_cli_output (vm, "Aborted due to a keypress.");
652 vec_free (event_data);
655 vlib_cli_output (vm, "\n");
659 n_requests) ? 0 : 100.0 * ((float) n_requests -
660 (float) n_replies) / (float) n_requests;
662 "Statistics: %u sent, %u received, %f%% packet loss\n",
663 n_requests, n_replies, loss);
664 /* Reset pr: running ping in other process could have changed pm->ping_runs */
665 pr = vec_elt_at_index (pm->ping_runs, ping_run_index);
666 hash_unset (pm->ping_run_by_icmp_id, icmp_id);
667 pool_put (pm->ping_runs, pr);
675 static clib_error_t *
676 ping_ip_address (vlib_main_t * vm,
677 unformat_input_t * input, vlib_cli_command_t * cmd)
681 clib_error_t *error = 0;
684 u8 ping_ip4, ping_ip6;
685 vnet_main_t *vnm = vnet_get_main ();
686 u32 data_len = PING_DEFAULT_DATA_LEN;
688 f64 ping_interval = PING_DEFAULT_INTERVAL;
689 u32 sw_if_index, table_id;
692 ping_ip4 = ping_ip6 = 0;
695 if (unformat (input, "%U", unformat_ip4_address, &a4))
699 else if (unformat (input, "%U", unformat_ip6_address, &a6))
703 else if (unformat (input, "ipv4"))
705 if (unformat (input, "%U", unformat_ip4_address, &a4))
712 clib_error_return (0,
713 "expecting IPv4 address but got `%U'",
714 format_unformat_error, input);
717 else if (unformat (input, "ipv6"))
719 if (unformat (input, "%U", unformat_ip6_address, &a6))
726 clib_error_return (0,
727 "expecting IPv6 address but got `%U'",
728 format_unformat_error, input);
734 clib_error_return (0,
735 "expecting IP4/IP6 address `%U'. Usage: ping <addr> [source <intf>] [size <datasz>] [repeat <count>] [verbose]",
736 format_unformat_error, input);
740 /* allow for the second AF in the same ping */
741 if (!ping_ip4 && (unformat (input, "ipv4")))
743 if (unformat (input, "%U", unformat_ip4_address, &a4))
748 else if (!ping_ip6 && (unformat (input, "ipv6")))
750 if (unformat (input, "%U", unformat_ip6_address, &a6))
756 /* parse the rest of the parameters in a cycle */
757 while (!unformat_eof (input, NULL))
759 if (unformat (input, "source"))
762 (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
765 clib_error_return (0,
766 "unknown interface `%U'",
767 format_unformat_error, input);
771 else if (unformat (input, "size"))
773 if (!unformat (input, "%u", &data_len))
776 clib_error_return (0,
777 "expecting size but got `%U'",
778 format_unformat_error, input);
781 if (data_len > PING_MAXIMUM_DATA_SIZE)
784 clib_error_return (0,
785 "%d is bigger than maximum allowed payload size %d",
786 data_len, PING_MAXIMUM_DATA_SIZE);
790 else if (unformat (input, "table-id"))
792 if (!unformat (input, "%u", &table_id))
795 clib_error_return (0,
796 "expecting table-id but got `%U'",
797 format_unformat_error, input);
801 else if (unformat (input, "interval"))
803 if (!unformat (input, "%f", &ping_interval))
806 clib_error_return (0,
807 "expecting interval (floating point number) got `%U'",
808 format_unformat_error, input);
812 else if (unformat (input, "repeat"))
814 if (!unformat (input, "%u", &ping_repeat))
817 clib_error_return (0,
818 "expecting repeat count but got `%U'",
819 format_unformat_error, input);
823 else if (unformat (input, "burst"))
825 if (!unformat (input, "%u", &ping_burst))
828 clib_error_return (0,
829 "expecting burst count but got `%U'",
830 format_unformat_error, input);
834 else if (unformat (input, "verbose"))
840 error = clib_error_return (0, "unknown input `%U'",
841 format_unformat_error, input);
846 if (ping_burst < 1 || ping_burst > VLIB_FRAME_SIZE)
847 return clib_error_return (0, "burst size must be between 1 and %u",
850 run_ping_ip46_address (vm, table_id, ping_ip4 ? &a4 : NULL,
851 ping_ip6 ? &a6 : NULL, sw_if_index, ping_interval,
852 ping_repeat, data_len, ping_burst, verbose);
858 * This command sends an ICMP ECHO_REQUEST to network hosts. The address
859 * can be an IPv4 or IPv6 address (or both at the same time).
863 * Example of how ping an IPv4 address:
864 * @cliexstart{ping 172.16.1.2 source GigabitEthernet2/0/0 repeat 2}
865 * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1090 ms
866 * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0914 ms
868 * Statistics: 2 sent, 2 received, 0% packet loss
871 * Example of how ping both an IPv4 address and IPv6 address at the same time:
872 * @cliexstart{ping 172.16.1.2 ipv6 fe80::24a5:f6ff:fe9c:3a36 source GigabitEthernet2/0/0 repeat 2 verbose}
873 * Adjacency index: 10, sw_if_index: 1
874 * Adj: ip6-discover-neighbor
876 * Forced set interface: 1
877 * Adjacency index: 0, sw_if_index: 4294967295
880 * Forced set interface: 1
881 * Source address: 172.16.1.1
882 * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1899 ms
883 * Adjacency index: 10, sw_if_index: 1
884 * Adj: ip6-discover-neighbor
886 * Forced set interface: 1
887 * Adjacency index: 0, sw_if_index: 4294967295
890 * Forced set interface: 1
891 * Source address: 172.16.1.1
892 * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0910 ms
894 * Statistics: 4 sent, 2 received, 50% packet loss
899 VLIB_CLI_COMMAND (ping_command, static) =
902 .function = ping_ip_address,
903 .short_help = "ping {<ip-addr> | ipv4 <ip4-addr> | ipv6 <ip6-addr>}"
904 " [ipv4 <ip4-addr> | ipv6 <ip6-addr>] [source <interface>]"
905 " [size <pktsize>] [interval <sec>] [repeat <cnt>] [table-id <id>]"
911 static clib_error_t *
912 ping_cli_init (vlib_main_t * vm)
914 ping_main_t *pm = &ping_main;
915 pm->ip6_main = &ip6_main;
916 pm->ip4_main = &ip4_main;
917 icmp6_register_type (vm, ICMP6_echo_reply, ip6_icmp_echo_reply_node.index);
918 ip4_icmp_register_type (vm, ICMP4_echo_reply,
919 ip4_icmp_echo_reply_node.index);
923 VLIB_INIT_FUNCTION (ping_cli_init);
926 * fd.io coding-style-patch-verification: ON
929 * eval: (c-set-style "gnu")