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>
25 * @brief IPv4 and IPv6 ICMP Ping.
27 * This file contains code to suppport IPv4 or IPv6 ICMP ECHO_REQUEST to
34 format_icmp_echo_trace (u8 * s, va_list * va)
36 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
37 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
38 icmp_echo_trace_t *t = va_arg (*va, icmp_echo_trace_t *);
40 s = format (s, "ICMP echo id %d seq %d%s",
41 clib_net_to_host_u16 (t->id),
42 clib_net_to_host_u16 (t->seq), t->bound ? "" : " (unknown)");
48 * If we can find the ping run by an ICMP ID, then we send the signal
49 * to the CLI process referenced by that ping run, alongside with
50 * a freshly made copy of the packet.
51 * I opted for a packet copy to keep the main packet processing path
52 * the same as for all the other nodes.
57 signal_ip46_icmp_reply_event (u8 event_type, vlib_buffer_t * b0)
59 ping_main_t *pm = &ping_main;
65 case PING_RESPONSE_IP4:
67 icmp4_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
68 net_icmp_id = h0->icmp_echo.id;
71 case PING_RESPONSE_IP6:
73 icmp6_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
74 net_icmp_id = h0->icmp_echo.id;
81 uword *p = hash_get (pm->ping_run_by_icmp_id,
82 clib_net_to_host_u16 (net_icmp_id));
86 ping_run_t *pr = vec_elt_at_index (pm->ping_runs, p[0]);
87 vlib_main_t *vm = vlib_mains[pr->cli_thread_index];
88 if (vlib_buffer_alloc (vm, &bi0_copy, 1) == 1)
90 void *dst = vlib_buffer_get_current (vlib_get_buffer (vm,
92 clib_memcpy (dst, vlib_buffer_get_current (b0), b0->current_length);
94 /* If buffer_alloc failed, bi0_copy == 0 - just signaling an event. */
95 f64 nowts = vlib_time_now (vm);
96 /* Pass the timestamp to the cli_process thanks to the vnet_buffer unused metadata field */
97 clib_memcpy (vnet_buffer
99 (vm, bi0_copy))->unused, &nowts, sizeof (nowts));
100 vlib_process_signal_event (vm, pr->cli_process_id, event_type, bi0_copy);
105 * Process ICMPv6 echo replies
108 ip6_icmp_echo_reply_node_fn (vlib_main_t * vm,
109 vlib_node_runtime_t * node, vlib_frame_t * frame)
111 u32 n_left_from, *from;
113 from = vlib_frame_vector_args (frame); /* array of buffer indices */
114 n_left_from = frame->n_vectors; /* number of buffer indices */
116 while (n_left_from > 0)
123 b0 = vlib_get_buffer (vm, bi0);
125 next0 = signal_ip46_icmp_reply_event (PING_RESPONSE_IP6, b0) ?
126 ICMP6_ECHO_REPLY_NEXT_DROP : ICMP6_ECHO_REPLY_NEXT_PUNT;
128 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
130 icmp6_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
131 icmp_echo_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
132 tr->id = h0->icmp_echo.id;
133 tr->seq = h0->icmp_echo.seq;
134 tr->bound = (next0 == ICMP6_ECHO_REPLY_NEXT_DROP);
137 /* push this pkt to the next graph node */
138 vlib_set_next_frame_buffer (vm, node, next0, bi0);
144 return frame->n_vectors;
148 VLIB_REGISTER_NODE (ip6_icmp_echo_reply_node, static) =
150 .function = ip6_icmp_echo_reply_node_fn,
151 .name = "ip6-icmp-echo-reply",
152 .vector_size = sizeof (u32),
153 .format_trace = format_icmp_echo_trace,
154 .n_next_nodes = ICMP6_ECHO_REPLY_N_NEXT,
156 [ICMP6_ECHO_REPLY_NEXT_DROP] = "error-drop",
157 [ICMP6_ECHO_REPLY_NEXT_PUNT] = "error-punt",
163 * Process ICMPv4 echo replies
166 ip4_icmp_echo_reply_node_fn (vlib_main_t * vm,
167 vlib_node_runtime_t * node, vlib_frame_t * frame)
169 u32 n_left_from, *from;
171 from = vlib_frame_vector_args (frame); /* array of buffer indices */
172 n_left_from = frame->n_vectors; /* number of buffer indices */
174 while (n_left_from > 0)
181 b0 = vlib_get_buffer (vm, bi0);
183 next0 = signal_ip46_icmp_reply_event (PING_RESPONSE_IP4, b0) ?
184 ICMP4_ECHO_REPLY_NEXT_DROP : ICMP4_ECHO_REPLY_NEXT_PUNT;
186 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
188 icmp4_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
189 icmp_echo_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
190 tr->id = h0->icmp_echo.id;
191 tr->seq = h0->icmp_echo.seq;
192 tr->bound = (next0 == ICMP4_ECHO_REPLY_NEXT_DROP);
195 /* push this pkt to the next graph node */
196 vlib_set_next_frame_buffer (vm, node, next0, bi0);
202 return frame->n_vectors;
206 VLIB_REGISTER_NODE (ip4_icmp_echo_reply_node, static) =
208 .function = ip4_icmp_echo_reply_node_fn,
209 .name = "ip4-icmp-echo-reply",
210 .vector_size = sizeof (u32),
211 .format_trace = format_icmp_echo_trace,
212 .n_next_nodes = ICMP4_ECHO_REPLY_N_NEXT,
214 [ICMP4_ECHO_REPLY_NEXT_DROP] = "error-drop",
215 [ICMP4_ECHO_REPLY_NEXT_PUNT] = "error-punt",
220 char *ip6_lookup_next_nodes[] = IP6_LOOKUP_NEXT_NODES;
221 char *ip4_lookup_next_nodes[] = IP4_LOOKUP_NEXT_NODES;
223 /* Fill in the ICMP ECHO structure, return the safety-checked and possibly shrunk data_len */
225 init_icmp46_echo_request (icmp46_echo_request_t * icmp46_echo,
226 u16 seq_host, u16 id_host, u16 data_len)
229 icmp46_echo->seq = clib_host_to_net_u16 (seq_host);
230 icmp46_echo->id = clib_host_to_net_u16 (id_host);
232 if (data_len > PING_MAXIMUM_DATA_SIZE)
233 data_len = PING_MAXIMUM_DATA_SIZE;
234 for (i = 0; i < data_len; i++)
235 icmp46_echo->data[i] = i % 256;
239 static send_ip46_ping_result_t
240 send_ip6_ping (vlib_main_t * vm, ip6_main_t * im,
241 u32 table_id, ip6_address_t * pa6,
242 u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len,
243 u32 burst, u8 verbose)
245 icmp6_echo_request_header_t *h0;
247 int bogus_length = 0;
251 vlib_buffer_free_list_t *fl;
253 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
254 return SEND_PING_ALLOC_FAIL;
256 p0 = vlib_get_buffer (vm, bi0);
257 fl = vlib_buffer_get_free_list (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
258 vlib_buffer_init_for_free_list (p0, fl);
259 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (p0);
262 * if the user did not provide a source interface, use the any interface
263 * that the destination resolves via.
265 if (~0 == sw_if_index)
267 fib_node_index_t fib_entry_index;
270 fib_index = ip6_fib_index_from_table_id (table_id);
274 vlib_buffer_free (vm, &bi0, 1);
275 return SEND_PING_NO_TABLE;
278 fib_entry_index = ip6_fib_table_lookup (fib_index, pa6, 128);
279 sw_if_index = fib_entry_get_resolving_interface (fib_entry_index);
281 * Set the TX interface to force ip-lookup to use its table ID
283 vnet_buffer (p0)->sw_if_index[VLIB_TX] = fib_index;
288 * force an IP lookup in the table bound to the user's chosen
291 vnet_buffer (p0)->sw_if_index[VLIB_TX] =
292 ip6_fib_table_get_index_for_sw_if_index (sw_if_index);
295 if (~0 == sw_if_index)
297 vlib_buffer_free (vm, &bi0, 1);
298 return SEND_PING_NO_INTERFACE;
301 vnet_buffer (p0)->sw_if_index[VLIB_RX] = sw_if_index;
303 h0 = vlib_buffer_get_current (p0);
305 /* Fill in ip6 header fields */
306 h0->ip6.ip_version_traffic_class_and_flow_label =
307 clib_host_to_net_u32 (0x6 << 28);
308 h0->ip6.payload_length = 0; /* Set below */
309 h0->ip6.protocol = IP_PROTOCOL_ICMP6;
310 h0->ip6.hop_limit = 255;
311 h0->ip6.dst_address = *pa6;
312 h0->ip6.src_address = *pa6;
314 /* Fill in the correct source now */
315 ip6_address_t *a = ip6_interface_first_address (im, sw_if_index);
318 vlib_buffer_free (vm, &bi0, 1);
319 return SEND_PING_NO_SRC_ADDRESS;
321 h0->ip6.src_address = a[0];
323 /* Fill in icmp fields */
324 h0->icmp.type = ICMP6_echo_request;
326 h0->icmp.checksum = 0;
329 init_icmp46_echo_request (&h0->icmp_echo, seq_host, id_host, data_len);
330 h0->icmp_echo.time_sent = vlib_time_now (vm);
332 /* Fix up the lengths */
333 h0->ip6.payload_length =
334 clib_host_to_net_u16 (data_len + sizeof (icmp46_header_t));
336 p0->current_length = clib_net_to_host_u16 (h0->ip6.payload_length) +
337 STRUCT_OFFSET_OF (icmp6_echo_request_header_t, icmp);
339 /* Calculate the ICMP checksum */
340 h0->icmp.checksum = 0;
342 ip6_tcp_udp_icmp_compute_checksum (vm, 0, &h0->ip6, &bogus_length);
344 /* Enqueue the packet right now */
345 f = vlib_get_frame_to_node (vm, ip6_lookup_node.index);
346 to_next = vlib_frame_vector_args (f);
349 ASSERT (burst <= VLIB_FRAME_SIZE);
350 f->n_vectors = burst;
353 vlib_buffer_t *c0 = vlib_buffer_copy (vm, p0);
355 to_next[0] = vlib_get_buffer_index (vm, c0);
357 vlib_put_frame_to_node (vm, ip6_lookup_node.index, f);
362 static send_ip46_ping_result_t
363 send_ip4_ping (vlib_main_t * vm,
368 u16 seq_host, u16 id_host, u16 data_len, u32 burst, u8 verbose)
370 icmp4_echo_request_header_t *h0;
372 ip_lookup_main_t *lm = &im->lookup_main;
377 vlib_buffer_free_list_t *fl;
379 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
380 return SEND_PING_ALLOC_FAIL;
382 p0 = vlib_get_buffer (vm, bi0);
383 fl = vlib_buffer_get_free_list (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
384 vlib_buffer_init_for_free_list (p0, fl);
385 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (p0);
388 * if the user did not provide a source interface, use the any interface
389 * that the destination resolves via.
391 if (~0 == sw_if_index)
393 fib_node_index_t fib_entry_index;
396 fib_index = ip4_fib_index_from_table_id (table_id);
400 vlib_buffer_free (vm, &bi0, 1);
401 return SEND_PING_NO_TABLE;
405 ip4_fib_table_lookup (ip4_fib_get (fib_index), pa4, 32);
406 sw_if_index = fib_entry_get_resolving_interface (fib_entry_index);
408 * Set the TX interface to force ip-lookup to use the user's table ID
410 vnet_buffer (p0)->sw_if_index[VLIB_TX] = fib_index;
415 * force an IP lookup in the table bound to the user's chosen
418 vnet_buffer (p0)->sw_if_index[VLIB_TX] =
419 ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
422 if (~0 == sw_if_index)
424 vlib_buffer_free (vm, &bi0, 1);
425 return SEND_PING_NO_INTERFACE;
428 vnet_buffer (p0)->sw_if_index[VLIB_RX] = sw_if_index;
430 h0 = vlib_buffer_get_current (p0);
432 /* Fill in ip4 header fields */
433 h0->ip4.checksum = 0;
434 h0->ip4.ip_version_and_header_length = 0x45;
436 h0->ip4.length = 0; /* Set below */
437 h0->ip4.fragment_id = 0;
438 h0->ip4.flags_and_fragment_offset = 0;
440 h0->ip4.protocol = IP_PROTOCOL_ICMP;
441 h0->ip4.dst_address = *pa4;
442 h0->ip4.src_address = *pa4;
444 /* Fill in the correct source now */
445 if_add_index0 = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
446 if (PREDICT_TRUE (if_add_index0 != ~0))
448 ip_interface_address_t *if_add =
449 pool_elt_at_index (lm->if_address_pool, if_add_index0);
450 ip4_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
451 h0->ip4.src_address = *if_ip;
454 vlib_cli_output (vm, "Source address: %U",
455 format_ip4_address, &h0->ip4.src_address);
459 /* Fill in icmp fields */
460 h0->icmp.type = ICMP4_echo_request;
462 h0->icmp.checksum = 0;
465 init_icmp46_echo_request (&h0->icmp_echo, seq_host, id_host, data_len);
466 h0->icmp_echo.time_sent = vlib_time_now (vm);
468 /* Fix up the lengths */
470 clib_host_to_net_u16 (data_len + sizeof (icmp46_header_t) +
471 sizeof (ip4_header_t));
473 p0->current_length = clib_net_to_host_u16 (h0->ip4.length);
475 /* Calculate the IP and ICMP checksums */
476 h0->ip4.checksum = ip4_header_checksum (&(h0->ip4));
478 ~ip_csum_fold (ip_incremental_checksum (0, &(h0->icmp),
480 sizeof (ip4_header_t)));
482 /* Enqueue the packet right now */
483 f = vlib_get_frame_to_node (vm, ip4_lookup_node.index);
484 to_next = vlib_frame_vector_args (f);
487 ASSERT (burst <= VLIB_FRAME_SIZE);
488 f->n_vectors = burst;
491 vlib_buffer_t *c0 = vlib_buffer_copy (vm, p0);
493 to_next[0] = vlib_get_buffer_index (vm, c0);
495 vlib_put_frame_to_node (vm, ip4_lookup_node.index, f);
502 print_ip6_icmp_reply (vlib_main_t * vm, u32 bi0)
504 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
505 icmp6_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
507 clib_memcpy (&rtt, vnet_buffer (b0)->unused, sizeof (rtt));
508 rtt -= h0->icmp_echo.time_sent;
510 "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
511 clib_host_to_net_u16 (h0->ip6.payload_length),
513 &h0->ip6.src_address,
514 clib_host_to_net_u16 (h0->icmp_echo.seq),
515 h0->ip6.hop_limit, rtt * 1000.0);
519 print_ip4_icmp_reply (vlib_main_t * vm, u32 bi0)
521 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
522 icmp4_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
524 clib_memcpy (&rtt, vnet_buffer (b0)->unused, sizeof (rtt));
525 rtt -= h0->icmp_echo.time_sent;
527 clib_host_to_net_u16 (h0->ip4.length) -
528 (4 * (0xF & h0->ip4.ip_version_and_header_length));
531 "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
534 &h0->ip4.src_address,
535 clib_host_to_net_u16 (h0->icmp_echo.seq),
536 h0->ip4.ttl, rtt * 1000.0);
541 * Perform the ping run with the given parameters in the current CLI process.
542 * Depending on whether pa4 or pa6 is set, runs IPv4 or IPv6 ping.
543 * The amusing side effect is of course if both are set, then both pings are sent.
544 * This behavior can be used to ping a dualstack host over IPv4 and IPv6 at once.
548 run_ping_ip46_address (vlib_main_t * vm, u32 table_id, ip4_address_t * pa4,
549 ip6_address_t * pa6, u32 sw_if_index,
550 f64 ping_interval, u32 ping_repeat, u32 data_len,
551 u32 ping_burst, u32 verbose)
554 ping_main_t *pm = &ping_main;
555 uword curr_proc = vlib_current_process (vm);
559 u32 ping_run_index = 0;
562 static u32 rand_seed = 0;
564 if (PREDICT_FALSE (!rand_seed))
565 rand_seed = random_default_seed ();
567 icmp_id = random_u32 (&rand_seed) & 0xffff;
569 while (hash_get (pm->ping_run_by_icmp_id, icmp_id))
571 vlib_cli_output (vm, "ICMP ID collision at %d, incrementing", icmp_id);
574 pool_get (pm->ping_runs, pr);
575 ping_run_index = pr - pm->ping_runs;
576 pr->cli_process_id = curr_proc;
577 pr->cli_thread_index = vlib_get_thread_index ();
578 pr->icmp_id = icmp_id;
579 hash_set (pm->ping_run_by_icmp_id, icmp_id, ping_run_index);
580 for (i = 1; i <= ping_repeat; i++)
583 f64 time_ping_sent = vlib_time_now (vm);
584 /* Reset pr: running ping in other process could have changed pm->ping_runs */
585 pr = vec_elt_at_index (pm->ping_runs, ping_run_index);
589 send_ip6_ping (vm, ping_main.ip6_main, table_id, pa6, sw_if_index,
590 i, icmp_id, data_len, ping_burst, verbose)))
592 n_requests += ping_burst;
596 send_ip4_ping (vm, ping_main.ip4_main, table_id, pa4, sw_if_index,
597 i, icmp_id, data_len, ping_burst, verbose)))
599 n_requests += ping_burst;
601 while ((i <= ping_repeat)
604 time_ping_sent + ping_interval - vlib_time_now (vm)) > 0.0))
606 uword event_type, *event_data = 0;
607 vlib_process_wait_for_event_or_clock (vm, sleep_interval);
608 event_type = vlib_process_get_events (vm, &event_data);
611 case ~0: /* no events => timeout */
613 case PING_RESPONSE_IP6:
616 for (i = 0; i < vec_len (event_data); i++)
618 u32 bi0 = event_data[i];
619 print_ip6_icmp_reply (vm, bi0);
623 vlib_buffer_free (vm, &bi0, 1);
628 case PING_RESPONSE_IP4:
631 for (i = 0; i < vec_len (event_data); i++)
633 u32 bi0 = event_data[i];
634 print_ip4_icmp_reply (vm, bi0);
638 vlib_buffer_free (vm, &bi0, 1);
644 /* someone pressed a key, abort */
645 vlib_cli_output (vm, "Aborted due to a keypress.");
649 vec_free(event_data);
652 vlib_cli_output (vm, "\n");
656 n_requests) ? 0 : 100.0 * ((float) n_requests -
657 (float) n_replies) / (float) n_requests;
659 "Statistics: %u sent, %u received, %f%% packet loss\n",
660 n_requests, n_replies, loss);
661 /* Reset pr: running ping in other process could have changed pm->ping_runs */
662 pr = vec_elt_at_index (pm->ping_runs, ping_run_index);
663 hash_unset (pm->ping_run_by_icmp_id, icmp_id);
664 pool_put (pm->ping_runs, pr);
672 static clib_error_t *
673 ping_ip_address (vlib_main_t * vm,
674 unformat_input_t * input, vlib_cli_command_t * cmd)
678 clib_error_t *error = 0;
681 u8 ping_ip4, ping_ip6;
682 vnet_main_t *vnm = vnet_get_main ();
683 u32 data_len = PING_DEFAULT_DATA_LEN;
685 f64 ping_interval = PING_DEFAULT_INTERVAL;
686 u32 sw_if_index, table_id;
689 ping_ip4 = ping_ip6 = 0;
692 if (unformat (input, "%U", unformat_ip4_address, &a4))
696 else if (unformat (input, "%U", unformat_ip6_address, &a6))
700 else if (unformat (input, "ipv4"))
702 if (unformat (input, "%U", unformat_ip4_address, &a4))
709 clib_error_return (0,
710 "expecting IPv4 address but got `%U'",
711 format_unformat_error, input);
714 else if (unformat (input, "ipv6"))
716 if (unformat (input, "%U", unformat_ip6_address, &a6))
723 clib_error_return (0,
724 "expecting IPv6 address but got `%U'",
725 format_unformat_error, input);
731 clib_error_return (0,
732 "expecting IP4/IP6 address `%U'. Usage: ping <addr> [source <intf>] [size <datasz>] [repeat <count>] [verbose]",
733 format_unformat_error, input);
737 /* allow for the second AF in the same ping */
738 if (!ping_ip4 && (unformat (input, "ipv4")))
740 if (unformat (input, "%U", unformat_ip4_address, &a4))
745 else if (!ping_ip6 && (unformat (input, "ipv6")))
747 if (unformat (input, "%U", unformat_ip6_address, &a6))
753 /* parse the rest of the parameters in a cycle */
754 while (!unformat_eof (input, NULL))
756 if (unformat (input, "source"))
759 (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
762 clib_error_return (0,
763 "unknown interface `%U'",
764 format_unformat_error, input);
768 else if (unformat (input, "size"))
770 if (!unformat (input, "%u", &data_len))
773 clib_error_return (0,
774 "expecting size but got `%U'",
775 format_unformat_error, input);
778 if (data_len > PING_MAXIMUM_DATA_SIZE)
781 clib_error_return (0,
782 "%d is bigger than maximum allowed payload size %d",
783 data_len, PING_MAXIMUM_DATA_SIZE);
787 else if (unformat (input, "table-id"))
789 if (!unformat (input, "%u", &table_id))
792 clib_error_return (0,
793 "expecting table-id but got `%U'",
794 format_unformat_error, input);
798 else if (unformat (input, "interval"))
800 if (!unformat (input, "%f", &ping_interval))
803 clib_error_return (0,
804 "expecting interval (floating point number) got `%U'",
805 format_unformat_error, input);
809 else if (unformat (input, "repeat"))
811 if (!unformat (input, "%u", &ping_repeat))
814 clib_error_return (0,
815 "expecting repeat count but got `%U'",
816 format_unformat_error, input);
820 else if (unformat (input, "burst"))
822 if (!unformat (input, "%u", &ping_burst))
825 clib_error_return (0,
826 "expecting burst count but got `%U'",
827 format_unformat_error, input);
831 else if (unformat (input, "verbose"))
837 error = clib_error_return (0, "unknown input `%U'",
838 format_unformat_error, input);
843 if (ping_burst < 1 || ping_burst > VLIB_FRAME_SIZE)
844 return clib_error_return (0, "burst size must be between 1 and %u",
847 run_ping_ip46_address (vm, table_id, ping_ip4 ? &a4 : NULL,
848 ping_ip6 ? &a6 : NULL, sw_if_index, ping_interval,
849 ping_repeat, data_len, ping_burst, verbose);
855 * This command sends an ICMP ECHO_REQUEST to network hosts. The address
856 * can be an IPv4 or IPv6 address (or both at the same time).
860 * Example of how ping an IPv4 address:
861 * @cliexstart{ping 172.16.1.2 source GigabitEthernet2/0/0 repeat 2}
862 * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1090 ms
863 * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0914 ms
865 * Statistics: 2 sent, 2 received, 0% packet loss
868 * Example of how ping both an IPv4 address and IPv6 address at the same time:
869 * @cliexstart{ping 172.16.1.2 ipv6 fe80::24a5:f6ff:fe9c:3a36 source GigabitEthernet2/0/0 repeat 2 verbose}
870 * Adjacency index: 10, sw_if_index: 1
871 * Adj: ip6-discover-neighbor
873 * Forced set interface: 1
874 * Adjacency index: 0, sw_if_index: 4294967295
877 * Forced set interface: 1
878 * Source address: 172.16.1.1
879 * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1899 ms
880 * Adjacency index: 10, sw_if_index: 1
881 * Adj: ip6-discover-neighbor
883 * Forced set interface: 1
884 * Adjacency index: 0, sw_if_index: 4294967295
887 * Forced set interface: 1
888 * Source address: 172.16.1.1
889 * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0910 ms
891 * Statistics: 4 sent, 2 received, 50% packet loss
896 VLIB_CLI_COMMAND (ping_command, static) =
899 .function = ping_ip_address,
900 .short_help = "ping {<ip-addr> | ipv4 <ip4-addr> | ipv6 <ip6-addr>}"
901 " [ipv4 <ip4-addr> | ipv6 <ip6-addr>] [source <interface>]"
902 " [size <pktsize>] [interval <sec>] [repeat <cnt>] [table-id <id>]"
908 static clib_error_t *
909 ping_cli_init (vlib_main_t * vm)
911 ping_main_t *pm = &ping_main;
912 pm->ip6_main = &ip6_main;
913 pm->ip4_main = &ip4_main;
914 icmp6_register_type (vm, ICMP6_echo_reply, ip6_icmp_echo_reply_node.index);
915 ip4_icmp_register_type (vm, ICMP4_echo_reply,
916 ip4_icmp_echo_reply_node.index);
920 VLIB_INIT_FUNCTION (ping_cli_init);
923 * fd.io coding-style-patch-verification: ON
926 * eval: (c-set-style "gnu")