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] = "error-drop",
159 [ICMP6_ECHO_REPLY_NEXT_PUNT] = "error-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] = "error-drop",
217 [ICMP4_ECHO_REPLY_NEXT_PUNT] = "error-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 ip6_address_t *a = ip6_interface_first_address (im, sw_if_index);
320 vlib_buffer_free (vm, &bi0, 1);
321 return SEND_PING_NO_SRC_ADDRESS;
323 h0->ip6.src_address = a[0];
325 /* Fill in icmp fields */
326 h0->icmp.type = ICMP6_echo_request;
328 h0->icmp.checksum = 0;
331 init_icmp46_echo_request (&h0->icmp_echo, seq_host, id_host, data_len);
332 h0->icmp_echo.time_sent = vlib_time_now (vm);
334 /* Fix up the lengths */
335 h0->ip6.payload_length =
336 clib_host_to_net_u16 (data_len + sizeof (icmp46_header_t));
338 p0->current_length = clib_net_to_host_u16 (h0->ip6.payload_length) +
339 STRUCT_OFFSET_OF (icmp6_echo_request_header_t, icmp);
341 /* Calculate the ICMP checksum */
342 h0->icmp.checksum = 0;
344 ip6_tcp_udp_icmp_compute_checksum (vm, 0, &h0->ip6, &bogus_length);
346 /* Enqueue the packet right now */
347 f = vlib_get_frame_to_node (vm, ip6_lookup_node.index);
348 to_next = vlib_frame_vector_args (f);
351 ASSERT (burst <= VLIB_FRAME_SIZE);
352 f->n_vectors = burst;
355 vlib_buffer_t *c0 = vlib_buffer_copy (vm, p0);
357 to_next[0] = vlib_get_buffer_index (vm, c0);
359 vlib_put_frame_to_node (vm, ip6_lookup_node.index, f);
364 static send_ip46_ping_result_t
365 send_ip4_ping (vlib_main_t * vm,
370 u16 seq_host, u16 id_host, u16 data_len, u32 burst, u8 verbose)
372 icmp4_echo_request_header_t *h0;
374 ip_lookup_main_t *lm = &im->lookup_main;
379 vlib_buffer_free_list_t *fl;
381 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
382 return SEND_PING_ALLOC_FAIL;
384 p0 = vlib_get_buffer (vm, bi0);
385 fl = vlib_buffer_get_free_list (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
386 vlib_buffer_init_for_free_list (p0, fl);
387 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (p0);
390 * if the user did not provide a source interface, use the any interface
391 * that the destination resolves via.
393 if (~0 == sw_if_index)
395 fib_node_index_t fib_entry_index;
398 fib_index = ip4_fib_index_from_table_id (table_id);
402 vlib_buffer_free (vm, &bi0, 1);
403 return SEND_PING_NO_TABLE;
407 ip4_fib_table_lookup (ip4_fib_get (fib_index), pa4, 32);
408 sw_if_index = fib_entry_get_resolving_interface (fib_entry_index);
410 * Set the TX interface to force ip-lookup to use the user's table ID
412 vnet_buffer (p0)->sw_if_index[VLIB_TX] = fib_index;
417 * force an IP lookup in the table bound to the user's chosen
420 vnet_buffer (p0)->sw_if_index[VLIB_TX] =
421 ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
424 if (~0 == sw_if_index)
426 vlib_buffer_free (vm, &bi0, 1);
427 return SEND_PING_NO_INTERFACE;
430 vnet_buffer (p0)->sw_if_index[VLIB_RX] = sw_if_index;
432 h0 = vlib_buffer_get_current (p0);
434 /* Fill in ip4 header fields */
435 h0->ip4.checksum = 0;
436 h0->ip4.ip_version_and_header_length = 0x45;
438 h0->ip4.length = 0; /* Set below */
439 h0->ip4.fragment_id = 0;
440 h0->ip4.flags_and_fragment_offset = 0;
442 h0->ip4.protocol = IP_PROTOCOL_ICMP;
443 h0->ip4.dst_address = *pa4;
444 h0->ip4.src_address = *pa4;
446 /* Fill in the correct source now */
447 if_add_index0 = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
448 if (PREDICT_TRUE (if_add_index0 != ~0))
450 ip_interface_address_t *if_add =
451 pool_elt_at_index (lm->if_address_pool, if_add_index0);
452 ip4_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
453 h0->ip4.src_address = *if_ip;
456 vlib_cli_output (vm, "Source address: %U",
457 format_ip4_address, &h0->ip4.src_address);
461 /* Fill in icmp fields */
462 h0->icmp.type = ICMP4_echo_request;
464 h0->icmp.checksum = 0;
467 init_icmp46_echo_request (&h0->icmp_echo, seq_host, id_host, data_len);
468 h0->icmp_echo.time_sent = vlib_time_now (vm);
470 /* Fix up the lengths */
472 clib_host_to_net_u16 (data_len + sizeof (icmp46_header_t) +
473 sizeof (ip4_header_t));
475 p0->current_length = clib_net_to_host_u16 (h0->ip4.length);
477 /* Calculate the IP and ICMP checksums */
478 h0->ip4.checksum = ip4_header_checksum (&(h0->ip4));
480 ~ip_csum_fold (ip_incremental_checksum (0, &(h0->icmp),
482 sizeof (ip4_header_t)));
484 /* Enqueue the packet right now */
485 f = vlib_get_frame_to_node (vm, ip4_lookup_node.index);
486 to_next = vlib_frame_vector_args (f);
489 ASSERT (burst <= VLIB_FRAME_SIZE);
490 f->n_vectors = burst;
493 vlib_buffer_t *c0 = vlib_buffer_copy (vm, p0);
495 to_next[0] = vlib_get_buffer_index (vm, c0);
497 vlib_put_frame_to_node (vm, ip4_lookup_node.index, f);
504 print_ip6_icmp_reply (vlib_main_t * vm, u32 bi0)
506 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
507 icmp6_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
509 clib_memcpy (&rtt, vnet_buffer (b0)->unused, sizeof (rtt));
510 rtt -= h0->icmp_echo.time_sent;
512 "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
513 clib_host_to_net_u16 (h0->ip6.payload_length),
515 &h0->ip6.src_address,
516 clib_host_to_net_u16 (h0->icmp_echo.seq),
517 h0->ip6.hop_limit, rtt * 1000.0);
521 print_ip4_icmp_reply (vlib_main_t * vm, u32 bi0)
523 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
524 icmp4_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
526 clib_memcpy (&rtt, vnet_buffer (b0)->unused, sizeof (rtt));
527 rtt -= h0->icmp_echo.time_sent;
529 clib_host_to_net_u16 (h0->ip4.length) -
530 (4 * (0xF & h0->ip4.ip_version_and_header_length));
533 "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
536 &h0->ip4.src_address,
537 clib_host_to_net_u16 (h0->icmp_echo.seq),
538 h0->ip4.ttl, rtt * 1000.0);
543 * Perform the ping run with the given parameters in the current CLI process.
544 * Depending on whether pa4 or pa6 is set, runs IPv4 or IPv6 ping.
545 * The amusing side effect is of course if both are set, then both pings are sent.
546 * This behavior can be used to ping a dualstack host over IPv4 and IPv6 at once.
550 run_ping_ip46_address (vlib_main_t * vm, u32 table_id, ip4_address_t * pa4,
551 ip6_address_t * pa6, u32 sw_if_index,
552 f64 ping_interval, u32 ping_repeat, u32 data_len,
553 u32 ping_burst, u32 verbose)
556 ping_main_t *pm = &ping_main;
557 uword curr_proc = vlib_current_process (vm);
561 u32 ping_run_index = 0;
564 static u32 rand_seed = 0;
566 if (PREDICT_FALSE (!rand_seed))
567 rand_seed = random_default_seed ();
569 icmp_id = random_u32 (&rand_seed) & 0xffff;
571 while (hash_get (pm->ping_run_by_icmp_id, icmp_id))
573 vlib_cli_output (vm, "ICMP ID collision at %d, incrementing", icmp_id);
576 pool_get (pm->ping_runs, pr);
577 ping_run_index = pr - pm->ping_runs;
578 pr->cli_process_id = curr_proc;
579 pr->cli_thread_index = vlib_get_thread_index ();
580 pr->icmp_id = icmp_id;
581 hash_set (pm->ping_run_by_icmp_id, icmp_id, ping_run_index);
582 for (i = 1; i <= ping_repeat; i++)
585 f64 time_ping_sent = vlib_time_now (vm);
586 /* Reset pr: running ping in other process could have changed pm->ping_runs */
587 pr = vec_elt_at_index (pm->ping_runs, ping_run_index);
591 send_ip6_ping (vm, ping_main.ip6_main, table_id, pa6, sw_if_index,
592 i, icmp_id, data_len, ping_burst, verbose)))
594 n_requests += ping_burst;
598 send_ip4_ping (vm, ping_main.ip4_main, table_id, pa4, sw_if_index,
599 i, icmp_id, data_len, ping_burst, verbose)))
601 n_requests += ping_burst;
603 while ((i <= ping_repeat)
606 time_ping_sent + ping_interval - vlib_time_now (vm)) > 0.0))
608 uword event_type, *event_data = 0;
609 vlib_process_wait_for_event_or_clock (vm, sleep_interval);
610 event_type = vlib_process_get_events (vm, &event_data);
613 case ~0: /* no events => timeout */
615 case PING_RESPONSE_IP6:
618 for (i = 0; i < vec_len (event_data); i++)
620 u32 bi0 = event_data[i];
621 print_ip6_icmp_reply (vm, bi0);
625 vlib_buffer_free (vm, &bi0, 1);
630 case PING_RESPONSE_IP4:
633 for (i = 0; i < vec_len (event_data); i++)
635 u32 bi0 = event_data[i];
636 print_ip4_icmp_reply (vm, bi0);
640 vlib_buffer_free (vm, &bi0, 1);
646 /* someone pressed a key, abort */
647 vlib_cli_output (vm, "Aborted due to a keypress.");
651 vec_free (event_data);
654 vlib_cli_output (vm, "\n");
658 n_requests) ? 0 : 100.0 * ((float) n_requests -
659 (float) n_replies) / (float) n_requests;
661 "Statistics: %u sent, %u received, %f%% packet loss\n",
662 n_requests, n_replies, loss);
663 /* Reset pr: running ping in other process could have changed pm->ping_runs */
664 pr = vec_elt_at_index (pm->ping_runs, ping_run_index);
665 hash_unset (pm->ping_run_by_icmp_id, icmp_id);
666 pool_put (pm->ping_runs, pr);
674 static clib_error_t *
675 ping_ip_address (vlib_main_t * vm,
676 unformat_input_t * input, vlib_cli_command_t * cmd)
680 clib_error_t *error = 0;
683 u8 ping_ip4, ping_ip6;
684 vnet_main_t *vnm = vnet_get_main ();
685 u32 data_len = PING_DEFAULT_DATA_LEN;
687 f64 ping_interval = PING_DEFAULT_INTERVAL;
688 u32 sw_if_index, table_id;
691 ping_ip4 = ping_ip6 = 0;
694 if (unformat (input, "%U", unformat_ip4_address, &a4))
698 else if (unformat (input, "%U", unformat_ip6_address, &a6))
702 else if (unformat (input, "ipv4"))
704 if (unformat (input, "%U", unformat_ip4_address, &a4))
711 clib_error_return (0,
712 "expecting IPv4 address but got `%U'",
713 format_unformat_error, input);
716 else if (unformat (input, "ipv6"))
718 if (unformat (input, "%U", unformat_ip6_address, &a6))
725 clib_error_return (0,
726 "expecting IPv6 address but got `%U'",
727 format_unformat_error, input);
733 clib_error_return (0,
734 "expecting IP4/IP6 address `%U'. Usage: ping <addr> [source <intf>] [size <datasz>] [repeat <count>] [verbose]",
735 format_unformat_error, input);
739 /* allow for the second AF in the same ping */
740 if (!ping_ip4 && (unformat (input, "ipv4")))
742 if (unformat (input, "%U", unformat_ip4_address, &a4))
747 else if (!ping_ip6 && (unformat (input, "ipv6")))
749 if (unformat (input, "%U", unformat_ip6_address, &a6))
755 /* parse the rest of the parameters in a cycle */
756 while (!unformat_eof (input, NULL))
758 if (unformat (input, "source"))
761 (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
764 clib_error_return (0,
765 "unknown interface `%U'",
766 format_unformat_error, input);
770 else if (unformat (input, "size"))
772 if (!unformat (input, "%u", &data_len))
775 clib_error_return (0,
776 "expecting size but got `%U'",
777 format_unformat_error, input);
780 if (data_len > PING_MAXIMUM_DATA_SIZE)
783 clib_error_return (0,
784 "%d is bigger than maximum allowed payload size %d",
785 data_len, PING_MAXIMUM_DATA_SIZE);
789 else if (unformat (input, "table-id"))
791 if (!unformat (input, "%u", &table_id))
794 clib_error_return (0,
795 "expecting table-id but got `%U'",
796 format_unformat_error, input);
800 else if (unformat (input, "interval"))
802 if (!unformat (input, "%f", &ping_interval))
805 clib_error_return (0,
806 "expecting interval (floating point number) got `%U'",
807 format_unformat_error, input);
811 else if (unformat (input, "repeat"))
813 if (!unformat (input, "%u", &ping_repeat))
816 clib_error_return (0,
817 "expecting repeat count but got `%U'",
818 format_unformat_error, input);
822 else if (unformat (input, "burst"))
824 if (!unformat (input, "%u", &ping_burst))
827 clib_error_return (0,
828 "expecting burst count but got `%U'",
829 format_unformat_error, input);
833 else if (unformat (input, "verbose"))
839 error = clib_error_return (0, "unknown input `%U'",
840 format_unformat_error, input);
845 if (ping_burst < 1 || ping_burst > VLIB_FRAME_SIZE)
846 return clib_error_return (0, "burst size must be between 1 and %u",
849 run_ping_ip46_address (vm, table_id, ping_ip4 ? &a4 : NULL,
850 ping_ip6 ? &a6 : NULL, sw_if_index, ping_interval,
851 ping_repeat, data_len, ping_burst, verbose);
857 * This command sends an ICMP ECHO_REQUEST to network hosts. The address
858 * can be an IPv4 or IPv6 address (or both at the same time).
862 * Example of how ping an IPv4 address:
863 * @cliexstart{ping 172.16.1.2 source GigabitEthernet2/0/0 repeat 2}
864 * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1090 ms
865 * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0914 ms
867 * Statistics: 2 sent, 2 received, 0% packet loss
870 * Example of how ping both an IPv4 address and IPv6 address at the same time:
871 * @cliexstart{ping 172.16.1.2 ipv6 fe80::24a5:f6ff:fe9c:3a36 source GigabitEthernet2/0/0 repeat 2 verbose}
872 * Adjacency index: 10, sw_if_index: 1
873 * Adj: ip6-discover-neighbor
875 * Forced set interface: 1
876 * Adjacency index: 0, sw_if_index: 4294967295
879 * Forced set interface: 1
880 * Source address: 172.16.1.1
881 * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1899 ms
882 * Adjacency index: 10, sw_if_index: 1
883 * Adj: ip6-discover-neighbor
885 * Forced set interface: 1
886 * Adjacency index: 0, sw_if_index: 4294967295
889 * Forced set interface: 1
890 * Source address: 172.16.1.1
891 * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0910 ms
893 * Statistics: 4 sent, 2 received, 50% packet loss
898 VLIB_CLI_COMMAND (ping_command, static) =
901 .function = ping_ip_address,
902 .short_help = "ping {<ip-addr> | ipv4 <ip4-addr> | ipv6 <ip6-addr>}"
903 " [ipv4 <ip4-addr> | ipv6 <ip6-addr>] [source <interface>]"
904 " [size <pktsize>] [interval <sec>] [repeat <cnt>] [table-id <id>]"
910 static clib_error_t *
911 ping_cli_init (vlib_main_t * vm)
913 ping_main_t *pm = &ping_main;
914 pm->ip6_main = &ip6_main;
915 pm->ip4_main = &ip4_main;
916 icmp6_register_type (vm, ICMP6_echo_reply, ip6_icmp_echo_reply_node.index);
917 ip4_icmp_register_type (vm, ICMP4_echo_reply,
918 ip4_icmp_echo_reply_node.index);
922 VLIB_INIT_FUNCTION (ping_cli_init);
925 * fd.io coding-style-patch-verification: ON
928 * eval: (c-set-style "gnu")