FD.io VPP  v17.10-9-gd594711
Vector Packet Processing
ping.c
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 
16 #include <stddef.h>
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>
22 
23 /**
24  * @file
25  * @brief IPv4 and IPv6 ICMP Ping.
26  *
27  * This file contains code to suppport IPv4 or IPv6 ICMP ECHO_REQUEST to
28  * network hosts.
29  *
30  */
31 
32 
33 u8 *
34 format_icmp_echo_trace (u8 * s, va_list * va)
35 {
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 *);
39 
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)");
43 
44  return s;
45 }
46 
47 /*
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.
53  *
54  */
55 
56 static int
58 {
59  ping_main_t *pm = &ping_main;
60  u16 net_icmp_id = 0;
61  u32 bi0_copy = 0;
62 
63  switch (event_type)
64  {
65  case PING_RESPONSE_IP4:
66  {
67  icmp4_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
68  net_icmp_id = h0->icmp_echo.id;
69  }
70  break;
71  case PING_RESPONSE_IP6:
72  {
73  icmp6_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
74  net_icmp_id = h0->icmp_echo.id;
75  }
76  break;
77  default:
78  return 0;
79  }
80 
82  clib_net_to_host_u16 (net_icmp_id));
83  if (!p)
84  return 0;
85 
86  ping_run_t *pr = vec_elt_at_index (pm->ping_runs, p[0]);
88  if (vlib_buffer_alloc (vm, &bi0_copy, 1) == 1)
89  {
91  bi0_copy));
93  }
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 */
99  (vm, bi0_copy))->unused, &nowts, sizeof (nowts));
100  vlib_process_signal_event_mt (vm, pr->cli_process_id, event_type, bi0_copy);
101  return 1;
102 }
103 
104 /*
105  * Process ICMPv6 echo replies
106  */
107 static uword
109  vlib_node_runtime_t * node, vlib_frame_t * frame)
110 {
111  u32 n_left_from, *from;
112 
113  from = vlib_frame_vector_args (frame); /* array of buffer indices */
114  n_left_from = frame->n_vectors; /* number of buffer indices */
115 
116  while (n_left_from > 0)
117  {
118  u32 bi0;
119  vlib_buffer_t *b0;
120  u32 next0;
121 
122  bi0 = from[0];
123  b0 = vlib_get_buffer (vm, bi0);
124 
127 
129  {
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);
135  }
136 
137  /* push this pkt to the next graph node */
138  vlib_set_next_frame_buffer (vm, node, next0, bi0);
139 
140  from += 1;
141  n_left_from -= 1;
142  }
143 
144  return frame->n_vectors;
145 }
146 
147 /* *INDENT-OFF* */
149 {
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,
155  .next_nodes = {
156  [ICMP6_ECHO_REPLY_NEXT_DROP] = "error-drop",
157  [ICMP6_ECHO_REPLY_NEXT_PUNT] = "error-punt",
158  },
159 };
160 /* *INDENT-ON* */
161 
162 /*
163  * Process ICMPv4 echo replies
164  */
165 static uword
167  vlib_node_runtime_t * node, vlib_frame_t * frame)
168 {
169  u32 n_left_from, *from;
170 
171  from = vlib_frame_vector_args (frame); /* array of buffer indices */
172  n_left_from = frame->n_vectors; /* number of buffer indices */
173 
174  while (n_left_from > 0)
175  {
176  u32 bi0;
177  vlib_buffer_t *b0;
178  u32 next0;
179 
180  bi0 = from[0];
181  b0 = vlib_get_buffer (vm, bi0);
182 
185 
187  {
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);
193  }
194 
195  /* push this pkt to the next graph node */
196  vlib_set_next_frame_buffer (vm, node, next0, bi0);
197 
198  from += 1;
199  n_left_from -= 1;
200  }
201 
202  return frame->n_vectors;
203 }
204 
205 /* *INDENT-OFF* */
207 {
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,
213  .next_nodes = {
214  [ICMP4_ECHO_REPLY_NEXT_DROP] = "error-drop",
215  [ICMP4_ECHO_REPLY_NEXT_PUNT] = "error-punt",
216  },
217 };
218 /* *INDENT-ON* */
219 
222 
223 /* Fill in the ICMP ECHO structure, return the safety-checked and possibly shrunk data_len */
224 static u16
225 init_icmp46_echo_request (icmp46_echo_request_t * icmp46_echo,
226  u16 seq_host, u16 id_host, u16 data_len)
227 {
228  int i;
229  icmp46_echo->seq = clib_host_to_net_u16 (seq_host);
230  icmp46_echo->id = clib_host_to_net_u16 (id_host);
231 
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;
236  return data_len;
237 }
238 
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)
244 {
245  icmp6_echo_request_header_t *h0;
246  u32 bi0 = 0;
247  int bogus_length = 0;
248  vlib_buffer_t *p0;
249  vlib_frame_t *f;
250  u32 *to_next;
252 
253  if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
254  return SEND_PING_ALLOC_FAIL;
255 
256  p0 = vlib_get_buffer (vm, bi0);
260 
261  /*
262  * if the user did not provide a source interface, use the any interface
263  * that the destination resolves via.
264  */
265  if (~0 == sw_if_index)
266  {
267  fib_node_index_t fib_entry_index;
268  u32 fib_index;
269 
270  fib_index = ip6_fib_index_from_table_id (table_id);
271 
272  if (~0 == fib_index)
273  {
274  vlib_buffer_free (vm, &bi0, 1);
275  return SEND_PING_NO_TABLE;
276  }
277 
278  fib_entry_index = ip6_fib_table_lookup (fib_index, pa6, 128);
279  sw_if_index = fib_entry_get_resolving_interface (fib_entry_index);
280  /*
281  * Set the TX interface to force ip-lookup to use its table ID
282  */
283  vnet_buffer (p0)->sw_if_index[VLIB_TX] = fib_index;
284  }
285  else
286  {
287  /*
288  * force an IP lookup in the table bound to the user's chosen
289  * source interface.
290  */
291  vnet_buffer (p0)->sw_if_index[VLIB_TX] =
293  }
294 
295  if (~0 == sw_if_index)
296  {
297  vlib_buffer_free (vm, &bi0, 1);
298  return SEND_PING_NO_INTERFACE;
299  }
300 
301  vnet_buffer (p0)->sw_if_index[VLIB_RX] = sw_if_index;
302 
303  h0 = vlib_buffer_get_current (p0);
304 
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;
313 
314  /* Fill in the correct source now */
315  ip6_address_t *a = ip6_interface_first_address (im, sw_if_index);
316  if (!a)
317  {
318  vlib_buffer_free (vm, &bi0, 1);
320  }
321  h0->ip6.src_address = a[0];
322 
323  /* Fill in icmp fields */
324  h0->icmp.type = ICMP6_echo_request;
325  h0->icmp.code = 0;
326  h0->icmp.checksum = 0;
327 
328  data_len =
329  init_icmp46_echo_request (&h0->icmp_echo, seq_host, id_host, data_len);
330  h0->icmp_echo.time_sent = vlib_time_now (vm);
331 
332  /* Fix up the lengths */
333  h0->ip6.payload_length =
334  clib_host_to_net_u16 (data_len + sizeof (icmp46_header_t));
335 
336  p0->current_length = clib_net_to_host_u16 (h0->ip6.payload_length) +
337  STRUCT_OFFSET_OF (icmp6_echo_request_header_t, icmp);
338 
339  /* Calculate the ICMP checksum */
340  h0->icmp.checksum = 0;
341  h0->icmp.checksum =
342  ip6_tcp_udp_icmp_compute_checksum (vm, 0, &h0->ip6, &bogus_length);
343 
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);
347  to_next[0] = bi0;
348 
349  ASSERT (burst <= VLIB_FRAME_SIZE);
350  f->n_vectors = burst;
351  while (--burst)
352  {
353  vlib_buffer_t *c0 = vlib_buffer_copy (vm, p0);
354  to_next++;
355  to_next[0] = vlib_get_buffer_index (vm, c0);
356  }
358 
359  return SEND_PING_OK;
360 }
361 
364  ip4_main_t * im,
365  u32 table_id,
366  ip4_address_t * pa4,
367  u32 sw_if_index,
368  u16 seq_host, u16 id_host, u16 data_len, u32 burst, u8 verbose)
369 {
370  icmp4_echo_request_header_t *h0;
371  u32 bi0 = 0;
372  ip_lookup_main_t *lm = &im->lookup_main;
373  vlib_buffer_t *p0;
374  vlib_frame_t *f;
375  u32 *to_next;
376  u32 if_add_index0;
378 
379  if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
380  return SEND_PING_ALLOC_FAIL;
381 
382  p0 = vlib_get_buffer (vm, bi0);
386 
387  /*
388  * if the user did not provide a source interface, use the any interface
389  * that the destination resolves via.
390  */
391  if (~0 == sw_if_index)
392  {
393  fib_node_index_t fib_entry_index;
394  u32 fib_index;
395 
396  fib_index = ip4_fib_index_from_table_id (table_id);
397 
398  if (~0 == fib_index)
399  {
400  vlib_buffer_free (vm, &bi0, 1);
401  return SEND_PING_NO_TABLE;
402  }
403 
404  fib_entry_index =
405  ip4_fib_table_lookup (ip4_fib_get (fib_index), pa4, 32);
406  sw_if_index = fib_entry_get_resolving_interface (fib_entry_index);
407  /*
408  * Set the TX interface to force ip-lookup to use the user's table ID
409  */
410  vnet_buffer (p0)->sw_if_index[VLIB_TX] = fib_index;
411  }
412  else
413  {
414  /*
415  * force an IP lookup in the table bound to the user's chosen
416  * source interface.
417  */
418  vnet_buffer (p0)->sw_if_index[VLIB_TX] =
420  }
421 
422  if (~0 == sw_if_index)
423  {
424  vlib_buffer_free (vm, &bi0, 1);
425  return SEND_PING_NO_INTERFACE;
426  }
427 
428  vnet_buffer (p0)->sw_if_index[VLIB_RX] = sw_if_index;
429 
430  h0 = vlib_buffer_get_current (p0);
431 
432  /* Fill in ip4 header fields */
433  h0->ip4.checksum = 0;
434  h0->ip4.ip_version_and_header_length = 0x45;
435  h0->ip4.tos = 0;
436  h0->ip4.length = 0; /* Set below */
437  h0->ip4.fragment_id = 0;
438  h0->ip4.flags_and_fragment_offset = 0;
439  h0->ip4.ttl = 0xff;
440  h0->ip4.protocol = IP_PROTOCOL_ICMP;
441  h0->ip4.dst_address = *pa4;
442  h0->ip4.src_address = *pa4;
443 
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))
447  {
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;
452  if (verbose)
453  {
454  vlib_cli_output (vm, "Source address: %U",
455  format_ip4_address, &h0->ip4.src_address);
456  }
457  }
458 
459  /* Fill in icmp fields */
460  h0->icmp.type = ICMP4_echo_request;
461  h0->icmp.code = 0;
462  h0->icmp.checksum = 0;
463 
464  data_len =
465  init_icmp46_echo_request (&h0->icmp_echo, seq_host, id_host, data_len);
466  h0->icmp_echo.time_sent = vlib_time_now (vm);
467 
468  /* Fix up the lengths */
469  h0->ip4.length =
470  clib_host_to_net_u16 (data_len + sizeof (icmp46_header_t) +
471  sizeof (ip4_header_t));
472 
473  p0->current_length = clib_net_to_host_u16 (h0->ip4.length);
474 
475  /* Calculate the IP and ICMP checksums */
476  h0->ip4.checksum = ip4_header_checksum (&(h0->ip4));
477  h0->icmp.checksum =
478  ~ip_csum_fold (ip_incremental_checksum (0, &(h0->icmp),
479  p0->current_length -
480  sizeof (ip4_header_t)));
481 
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);
485  to_next[0] = bi0;
486 
487  ASSERT (burst <= VLIB_FRAME_SIZE);
488  f->n_vectors = burst;
489  while (--burst)
490  {
491  vlib_buffer_t *c0 = vlib_buffer_copy (vm, p0);
492  to_next++;
493  to_next[0] = vlib_get_buffer_index (vm, c0);
494  }
496 
497  return SEND_PING_OK;
498 }
499 
500 
501 static void
503 {
504  vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
505  icmp6_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
506  f64 rtt = 0;
507  clib_memcpy (&rtt, vnet_buffer (b0)->unused, sizeof (rtt));
508  rtt -= h0->icmp_echo.time_sent;
509  vlib_cli_output (vm,
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);
516 }
517 
518 static void
520 {
521  vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
522  icmp4_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
523  f64 rtt = 0;
524  clib_memcpy (&rtt, vnet_buffer (b0)->unused, sizeof (rtt));
525  rtt -= h0->icmp_echo.time_sent;
526  u32 rcvd_icmp_len =
527  clib_host_to_net_u16 (h0->ip4.length) -
528  (4 * (0xF & h0->ip4.ip_version_and_header_length));
529 
530  vlib_cli_output (vm,
531  "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
532  rcvd_icmp_len,
534  &h0->ip4.src_address,
535  clib_host_to_net_u16 (h0->icmp_echo.seq),
536  h0->ip4.ttl, rtt * 1000.0);
537 }
538 
539 
540 /*
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.
545  */
546 
547 static void
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)
552 {
553  int i;
554  ping_main_t *pm = &ping_main;
555  uword curr_proc = vlib_current_process (vm);
556  u32 n_replies = 0;
557  u32 n_requests = 0;
558  ping_run_t *pr = 0;
559  u32 ping_run_index = 0;
560  u16 icmp_id;
561 
562  static u32 rand_seed = 0;
563 
564  if (PREDICT_FALSE (!rand_seed))
565  rand_seed = random_default_seed ();
566 
567  icmp_id = random_u32 (&rand_seed) & 0xffff;
568 
569  while (hash_get (pm->ping_run_by_icmp_id, icmp_id))
570  {
571  vlib_cli_output (vm, "ICMP ID collision at %d, incrementing", icmp_id);
572  icmp_id++;
573  }
574  pool_get (pm->ping_runs, pr);
575  ping_run_index = pr - pm->ping_runs;
576  pr->cli_process_id = curr_proc;
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++)
581  {
582  f64 sleep_interval;
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);
586  pr->curr_seq = i;
587  if (pa6 &&
588  (SEND_PING_OK ==
589  send_ip6_ping (vm, ping_main.ip6_main, table_id, pa6, sw_if_index,
590  i, icmp_id, data_len, ping_burst, verbose)))
591  {
592  n_requests += ping_burst;
593  }
594  if (pa4 &&
595  (SEND_PING_OK ==
596  send_ip4_ping (vm, ping_main.ip4_main, table_id, pa4, sw_if_index,
597  i, icmp_id, data_len, ping_burst, verbose)))
598  {
599  n_requests += ping_burst;
600  }
601  while ((i <= ping_repeat)
602  &&
603  ((sleep_interval =
604  time_ping_sent + ping_interval - vlib_time_now (vm)) > 0.0))
605  {
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);
609  switch (event_type)
610  {
611  case ~0: /* no events => timeout */
612  break;
613  case PING_RESPONSE_IP6:
614  {
615  int i;
616  for (i = 0; i < vec_len (event_data); i++)
617  {
618  u32 bi0 = event_data[i];
619  print_ip6_icmp_reply (vm, bi0);
620  n_replies++;
621  if (0 != bi0)
622  {
623  vlib_buffer_free (vm, &bi0, 1);
624  }
625  }
626  }
627  break;
628  case PING_RESPONSE_IP4:
629  {
630  int i;
631  for (i = 0; i < vec_len (event_data); i++)
632  {
633  u32 bi0 = event_data[i];
634  print_ip4_icmp_reply (vm, bi0);
635  n_replies++;
636  if (0 != bi0)
637  {
638  vlib_buffer_free (vm, &bi0, 1);
639  }
640  }
641  }
642  break;
643  default:
644  /* someone pressed a key, abort */
645  vlib_cli_output (vm, "Aborted due to a keypress.");
646  i = 1 + ping_repeat;
647  break;
648  }
649  vec_free (event_data);
650  }
651  }
652  vlib_cli_output (vm, "\n");
653  {
654  float loss =
655  (0 ==
656  n_requests) ? 0 : 100.0 * ((float) n_requests -
657  (float) n_replies) / (float) n_requests;
658  vlib_cli_output (vm,
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);
665  }
666 }
667 
668 
669 
670 
671 
672 static clib_error_t *
674  unformat_input_t * input, vlib_cli_command_t * cmd)
675 {
676  ip4_address_t a4;
677  ip6_address_t a6;
678  clib_error_t *error = 0;
679  u32 ping_repeat = 5;
680  u32 ping_burst = 1;
681  u8 ping_ip4, ping_ip6;
682  vnet_main_t *vnm = vnet_get_main ();
683  u32 data_len = PING_DEFAULT_DATA_LEN;
684  u32 verbose = 0;
685  f64 ping_interval = PING_DEFAULT_INTERVAL;
686  u32 sw_if_index, table_id;
687 
688  table_id = 0;
689  ping_ip4 = ping_ip6 = 0;
690  sw_if_index = ~0;
691 
692  if (unformat (input, "%U", unformat_ip4_address, &a4))
693  {
694  ping_ip4 = 1;
695  }
696  else if (unformat (input, "%U", unformat_ip6_address, &a6))
697  {
698  ping_ip6 = 1;
699  }
700  else if (unformat (input, "ipv4"))
701  {
702  if (unformat (input, "%U", unformat_ip4_address, &a4))
703  {
704  ping_ip4 = 1;
705  }
706  else
707  {
708  error =
710  "expecting IPv4 address but got `%U'",
711  format_unformat_error, input);
712  }
713  }
714  else if (unformat (input, "ipv6"))
715  {
716  if (unformat (input, "%U", unformat_ip6_address, &a6))
717  {
718  ping_ip6 = 1;
719  }
720  else
721  {
722  error =
724  "expecting IPv6 address but got `%U'",
725  format_unformat_error, input);
726  }
727  }
728  else
729  {
730  error =
732  "expecting IP4/IP6 address `%U'. Usage: ping <addr> [source <intf>] [size <datasz>] [repeat <count>] [verbose]",
733  format_unformat_error, input);
734  goto done;
735  }
736 
737  /* allow for the second AF in the same ping */
738  if (!ping_ip4 && (unformat (input, "ipv4")))
739  {
740  if (unformat (input, "%U", unformat_ip4_address, &a4))
741  {
742  ping_ip4 = 1;
743  }
744  }
745  else if (!ping_ip6 && (unformat (input, "ipv6")))
746  {
747  if (unformat (input, "%U", unformat_ip6_address, &a6))
748  {
749  ping_ip6 = 1;
750  }
751  }
752 
753  /* parse the rest of the parameters in a cycle */
754  while (!unformat_eof (input, NULL))
755  {
756  if (unformat (input, "source"))
757  {
758  if (!unformat_user
759  (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
760  {
761  error =
763  "unknown interface `%U'",
764  format_unformat_error, input);
765  goto done;
766  }
767  }
768  else if (unformat (input, "size"))
769  {
770  if (!unformat (input, "%u", &data_len))
771  {
772  error =
774  "expecting size but got `%U'",
775  format_unformat_error, input);
776  goto done;
777  }
778  if (data_len > PING_MAXIMUM_DATA_SIZE)
779  {
780  error =
782  "%d is bigger than maximum allowed payload size %d",
783  data_len, PING_MAXIMUM_DATA_SIZE);
784  goto done;
785  }
786  }
787  else if (unformat (input, "table-id"))
788  {
789  if (!unformat (input, "%u", &table_id))
790  {
791  error =
793  "expecting table-id but got `%U'",
794  format_unformat_error, input);
795  goto done;
796  }
797  }
798  else if (unformat (input, "interval"))
799  {
800  if (!unformat (input, "%f", &ping_interval))
801  {
802  error =
804  "expecting interval (floating point number) got `%U'",
805  format_unformat_error, input);
806  goto done;
807  }
808  }
809  else if (unformat (input, "repeat"))
810  {
811  if (!unformat (input, "%u", &ping_repeat))
812  {
813  error =
815  "expecting repeat count but got `%U'",
816  format_unformat_error, input);
817  goto done;
818  }
819  }
820  else if (unformat (input, "burst"))
821  {
822  if (!unformat (input, "%u", &ping_burst))
823  {
824  error =
826  "expecting burst count but got `%U'",
827  format_unformat_error, input);
828  goto done;
829  }
830  }
831  else if (unformat (input, "verbose"))
832  {
833  verbose = 1;
834  }
835  else
836  {
837  error = clib_error_return (0, "unknown input `%U'",
838  format_unformat_error, input);
839  goto done;
840  }
841  }
842 
843  if (ping_burst < 1 || ping_burst > VLIB_FRAME_SIZE)
844  return clib_error_return (0, "burst size must be between 1 and %u",
845  VLIB_FRAME_SIZE);
846 
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);
850 done:
851  return error;
852 }
853 
854 /*?
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).
857  *
858  * @cliexpar
859  * @parblock
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
864  *
865  * Statistics: 2 sent, 2 received, 0% packet loss
866  * @cliexend
867  *
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
872  * Adj Interface: 0
873  * Forced set interface: 1
874  * Adjacency index: 0, sw_if_index: 4294967295
875  * Adj: ip4-miss
876  * Adj Interface: 0
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
882  * Adj Interface: 0
883  * Forced set interface: 1
884  * Adjacency index: 0, sw_if_index: 4294967295
885  * Adj: ip4-miss
886  * Adj Interface: 0
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
890  *
891  * Statistics: 4 sent, 2 received, 50% packet loss
892  * @cliexend
893  * @endparblock
894 ?*/
895 /* *INDENT-OFF* */
896 VLIB_CLI_COMMAND (ping_command, static) =
897 {
898  .path = "ping",
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>]"
903  " [verbose]",
904  .is_mp_safe = 1,
905 };
906 /* *INDENT-ON* */
907 
908 static clib_error_t *
910 {
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,
917  return 0;
918 }
919 
921 
922 /*
923  * fd.io coding-style-patch-verification: ON
924  *
925  * Local Variables:
926  * eval: (c-set-style "gnu")
927  * End:
928  */
char * ip6_lookup_next_nodes[]
Definition: ping.c:220
char * ip4_lookup_next_nodes[]
Definition: ping.c:221
#define hash_set(h, key, value)
Definition: hash.h:254
sll srl srl sll sra u16x4 i
Definition: vector_sse2.h:337
#define CLIB_UNUSED(x)
Definition: clib.h:79
static uword random_default_seed(void)
Default random seed (unix/linux user-mode)
Definition: random.h:91
static f64 vlib_process_wait_for_event_or_clock(vlib_main_t *vm, f64 dt)
Suspend a cooperative multi-tasking thread Waits for an event, or for the indicated number of seconds...
Definition: node_funcs.h:699
#define hash_unset(h, key)
Definition: hash.h:260
a
Definition: bitmap.h:516
static void vlib_buffer_free(vlib_main_t *vm, u32 *buffers, u32 n_buffers)
Free buffers Frees the entire buffer chain for each buffer.
Definition: buffer_funcs.h:317
#define IP6_LOOKUP_NEXT_NODES
Definition: adj.h:118
static void vlib_set_next_frame_buffer(vlib_main_t *vm, vlib_node_runtime_t *node, u32 next_index, u32 buffer_index)
Definition: node_funcs.h:397
ip_interface_address_t * if_address_pool
Pool of addresses that are assigned to interfaces.
Definition: lookup.h:122
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
static uword vlib_current_process(vlib_main_t *vm)
Definition: node_funcs.h:426
unformat_function_t unformat_eof
Definition: format.h:291
#define PREDICT_TRUE(x)
Definition: clib.h:98
static send_ip46_ping_result_t send_ip6_ping(vlib_main_t *vm, ip6_main_t *im, u32 table_id, ip6_address_t *pa6, u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len, u32 burst, u8 verbose)
Definition: ping.c:240
#define NULL
Definition: clib.h:55
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:221
static u16 init_icmp46_echo_request(icmp46_echo_request_t *icmp46_echo, u16 seq_host, u16 id_host, u16 data_len)
Definition: ping.c:225
ip6_address_t * ip6_interface_first_address(ip6_main_t *im, u32 sw_if_index)
get first IPv6 interface address
Definition: ip6_forward.c:453
ip4_main_t * ip4_main
Definition: ping.h:52
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:62
ip_lookup_main_t lookup_main
Definition: ip4.h:97
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
unformat_function_t unformat_vnet_sw_interface
static void print_ip6_icmp_reply(vlib_main_t *vm, u32 bi0)
Definition: ping.c:502
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:225
vlib_main_t ** vlib_mains
Definition: buffer.c:292
u8 * format_icmp_echo_trace(u8 *s, va_list *va)
Definition: ping.c:34
static vlib_buffer_t * vlib_buffer_copy(vlib_main_t *vm, vlib_buffer_t *b)
Definition: buffer_funcs.h:465
send_ip46_ping_result_t
Definition: ping.h:29
uword cli_thread_index
Definition: ping.h:46
vlib_node_registration_t ip4_lookup_node
(constructor) VLIB_REGISTER_NODE (ip4_lookup_node)
Definition: ip4_forward.c:479
static uword ip4_icmp_echo_reply_node_fn(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: ping.c:166
u32 ip4_fib_table_get_index_for_sw_if_index(u32 sw_if_index)
Definition: ip4_fib.c:223
format_function_t format_ip4_address
Definition: format.h:79
unformat_function_t unformat_ip4_address
Definition: format.h:76
ip_csum_t ip_incremental_checksum(ip_csum_t sum, void *_data, uword n_bytes)
Definition: ip_checksum.c:43
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:111
static uword vlib_process_get_events(vlib_main_t *vm, uword **data_vector)
Return the first event type which has occurred and a vector of per-event data of that type...
Definition: node_funcs.h:542
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
vlib_frame_t * vlib_get_frame_to_node(vlib_main_t *vm, u32 to_node_index)
Definition: main.c:182
#define clib_error_return(e, args...)
Definition: error.h:99
ping_run_t * ping_runs
Definition: ping.h:53
u32 ip6_fib_table_get_index_for_sw_if_index(u32 sw_if_index)
Definition: ip6_fib.c:355
static u32 vlib_get_buffer_index(vlib_main_t *vm, void *p)
Translate buffer pointer into buffer index.
Definition: buffer_funcs.h:74
#define fl(x, y)
void ip4_icmp_register_type(vlib_main_t *vm, icmp4_type_t type, u32 node_index)
Definition: icmp4.c:731
static clib_error_t * ping_cli_init(vlib_main_t *vm)
Definition: ping.c:909
#define hash_get(h, key)
Definition: hash.h:248
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:458
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:72
static u32 ip6_fib_index_from_table_id(u32 table_id)
Definition: ip6_fib.h:159
struct _unformat_input_t unformat_input_t
static send_ip46_ping_result_t send_ip4_ping(vlib_main_t *vm, ip4_main_t *im, u32 table_id, ip4_address_t *pa4, u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len, u32 burst, u8 verbose)
Definition: ping.c:363
void vlib_put_frame_to_node(vlib_main_t *vm, u32 to_node_index, vlib_frame_t *f)
Definition: main.c:191
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:193
#define VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX
Definition: buffer.h:422
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:270
#define PREDICT_FALSE(x)
Definition: clib.h:97
#define VLIB_FRAME_SIZE
Definition: node.h:328
u32 fib_entry_get_resolving_interface(fib_node_index_t entry_index)
Definition: fib_entry.c:1353
unformat_function_t unformat_ip6_address
Definition: format.h:94
fib_node_index_t ip4_fib_table_lookup(const ip4_fib_t *fib, const ip4_address_t *addr, u32 len)
Definition: ip4_fib.c:290
u16 curr_seq
Definition: ping.h:44
#define IP4_LOOKUP_NEXT_NODES
Definition: adj.h:105
#define PING_DEFAULT_INTERVAL
Definition: ping.h:62
u16 n_vectors
Definition: node.h:344
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:221
format_function_t format_ip6_address
Definition: format.h:95
vlib_main_t * vm
Definition: buffer.c:283
static vlib_node_registration_t ip6_icmp_echo_reply_node
(constructor) VLIB_REGISTER_NODE (ip6_icmp_echo_reply_node)
Definition: ping.c:148
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:336
static void vlib_process_signal_event_mt(vlib_main_t *vm, uword node_index, uword type_opaque, uword data)
Signal event to process from any thread.
Definition: node_funcs.h:974
static ip4_fib_t * ip4_fib_get(u32 index)
Get the FIB at the given index.
Definition: ip4_fib.h:105
static vlib_node_registration_t ip4_icmp_echo_reply_node
(constructor) VLIB_REGISTER_NODE (ip4_icmp_echo_reply_node)
Definition: ping.c:206
ip6_main_t * ip6_main
Definition: ping.h:51
#define VLIB_BUFFER_IS_TRACED
Definition: buffer.h:93
#define clib_memcpy(a, b, c)
Definition: string.h:69
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:28
static u32 ip4_fib_index_from_table_id(u32 table_id)
Definition: ip4_fib.h:136
static void run_ping_ip46_address(vlib_main_t *vm, u32 table_id, ip4_address_t *pa4, ip6_address_t *pa6, u32 sw_if_index, f64 ping_interval, u32 ping_repeat, u32 data_len, u32 ping_burst, u32 verbose)
Definition: ping.c:548
uword cli_process_id
Definition: ping.h:45
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:154
u32 * if_address_pool_index_by_sw_if_index
Head of doubly linked list of interface addresses for each software interface.
Definition: lookup.h:129
u16 ip6_tcp_udp_icmp_compute_checksum(vlib_main_t *vm, vlib_buffer_t *p0, ip6_header_t *ip0, int *bogus_lengthp)
Definition: ip6_forward.c:1202
vlib_node_registration_t ip6_lookup_node
(constructor) VLIB_REGISTER_NODE (ip6_lookup_node)
Definition: ip6_forward.c:740
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
ip6_main_t ip6_main
Definition: ip6_forward.c:3043
#define PING_MAXIMUM_DATA_SIZE
Definition: ping.h:64
IPv4 main type.
Definition: ip4.h:95
static void print_ip4_icmp_reply(vlib_main_t *vm, u32 bi0)
Definition: ping.c:519
u64 uword
Definition: types.h:112
static void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace_funcs.h:55
Definition: defs.h:47
unsigned short u16
Definition: types.h:57
void icmp6_register_type(vlib_main_t *vm, icmp6_type_t type, u32 node_index)
Definition: icmp6.c:803
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
#define VLIB_BUFFER_TRACE_TRAJECTORY_INIT(b)
Definition: buffer.h:517
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:267
ping_main_t ping_main
Definition: ping.h:59
static void vlib_buffer_init_for_free_list(vlib_buffer_t *dst, vlib_buffer_free_list_t *fl)
Definition: buffer_funcs.h:770
#define vnet_buffer(b)
Definition: buffer.h:306
static uword ip6_icmp_echo_reply_node_fn(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: ping.c:108
u16 icmp_id
Definition: ping.h:43
static u32 random_u32(u32 *seed)
32-bit random number generator
Definition: random.h:69
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:143
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:1175
static int signal_ip46_icmp_reply_event(u8 event_type, vlib_buffer_t *b0)
Definition: ping.c:57
ping_run_t * ping_run_by_icmp_id
Definition: ping.h:56
fib_node_index_t ip6_fib_table_lookup(u32 fib_index, const ip6_address_t *addr, u32 len)
Definition: ip6_fib.c:201
#define PING_DEFAULT_DATA_LEN
Definition: ping.h:61
static vlib_buffer_free_list_t * vlib_buffer_get_free_list(vlib_main_t *vm, u32 free_list_index)
Definition: buffer_funcs.h:412
static void * ip_interface_address_get_address(ip_lookup_main_t *lm, ip_interface_address_t *a)
Definition: lookup.h:172
static clib_error_t * ping_ip_address(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: ping.c:673
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:75
static u32 vlib_buffer_alloc(vlib_main_t *vm, u32 *buffers, u32 n_buffers)
Allocate buffers into supplied array.
Definition: buffer_funcs.h:254
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:680
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:57
static u16 ip4_header_checksum(ip4_header_t *i)
Definition: ip4_packet.h:239
static u16 ip_csum_fold(ip_csum_t c)
Definition: ip_packet.h:145
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
Definition: defs.h:46