vnet/vnet/ip/ping.c

   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 <vnet/ip/ping.h>
  17 #include <vnet/fib/ip6_fib.h>
  18 #include <vnet/fib/ip4_fib.h>
  19 #include <vnet/fib/fib_entry.h>
  20
  21 /**
  22  * @file
  23  * @brief IPv4 and IPv6 ICMP Ping.
  24  *
  25  * This file contains code to suppport IPv4 or IPv6 ICMP ECHO_REQUEST to
  26  * network hosts.
  27  *
  28  */
  29
  30
  31 u8 *
  32 format_icmp4_input_trace (u8 * s, va_list * va)
  33 {
  34   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
  35   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
  36   icmp4_input_trace_t *t = va_arg (*va, icmp4_input_trace_t *);
  37
  38   s = format (s, "%U",
  39               format_ip4_header, t->packet_data, sizeof (t->packet_data));
  40
  41   return s;
  42 }
  43
  44 /*
  45  * If we can find the ping run by an ICMP ID, then we send the signal
  46  * to the CLI process referenced by that ping run, alongside with
  47  * a freshly made copy of the packet.
  48  * I opted for a packet copy to keep the main packet processing path
  49  * the same as for all the other nodes.
  50  *
  51  */
  52
  53 static void
  54 signal_ip46_icmp_reply_event (vlib_main_t * vm,
  55                               u8 event_type, vlib_buffer_t * b0)
  56 {
  57   ping_main_t *pm = &ping_main;
  58   u16 net_icmp_id = 0;
  59   u32 bi0_copy = 0;
  60
  61   switch (event_type)
  62     {
  63     case PING_RESPONSE_IP4:
  64       {
  65         icmp4_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
  66         net_icmp_id = h0->icmp_echo.id;
  67       }
  68       break;
  69     case PING_RESPONSE_IP6:
  70       {
  71         icmp6_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
  72         net_icmp_id = h0->icmp_echo.id;
  73       }
  74       break;
  75     default:
  76       return;
  77     }
  78
  79   uword *p = hash_get (pm->ping_run_by_icmp_id,
  80                        clib_net_to_host_u16 (net_icmp_id));
  81   if (!p)
  82     return;
  83
  84   ping_run_t *pr = vec_elt_at_index (pm->ping_runs, p[0]);
  85   if (vlib_buffer_alloc (vm, &bi0_copy, 1) == 1)
  86     {
  87       void *dst = vlib_buffer_get_current (vlib_get_buffer (vm, bi0_copy));
  88       clib_memcpy (dst, vlib_buffer_get_current (b0), b0->current_length);
  89     }
  90   /* If buffer_alloc failed, bi0_copy == 0 - just signaling an event. */
  91
  92   vlib_process_signal_event (vm, pr->cli_process_id, event_type, bi0_copy);
  93 }
  94
  95 /*
  96  * Process ICMPv6 echo replies
  97  */
  98 static uword
  99 ip6_icmp_echo_reply_node_fn (vlib_main_t * vm,
 100                              vlib_node_runtime_t * node, vlib_frame_t * frame)
 101 {
 102   u32 n_left_from, *from;
 103
 104   from = vlib_frame_vector_args (frame);        /* array of buffer indices */
 105   n_left_from = frame->n_vectors;       /* number of buffer indices */
 106
 107   while (n_left_from > 0)
 108     {
 109       u32 bi0;
 110       vlib_buffer_t *b0;
 111       u32 next0;
 112
 113       bi0 = from[0];
 114       b0 = vlib_get_buffer (vm, bi0);
 115
 116       signal_ip46_icmp_reply_event (vm, PING_RESPONSE_IP6, b0);
 117
 118       /* push this pkt to the next graph node, always error-drop */
 119       next0 = ICMP6_ECHO_REPLY_NEXT_NORMAL;
 120       vlib_set_next_frame_buffer (vm, node, next0, bi0);
 121
 122       from += 1;
 123       n_left_from -= 1;
 124     }
 125
 126   return frame->n_vectors;
 127 }
 128
 129 /* *INDENT-OFF* */
 130 VLIB_REGISTER_NODE (ip6_icmp_echo_reply_node, static) =
 131 {
 132   .function = ip6_icmp_echo_reply_node_fn,
 133   .name = "ip6-icmp-echo-reply",
 134   .vector_size = sizeof (u32),
 135   .format_trace = format_icmp6_input_trace,
 136   .n_next_nodes = ICMP6_ECHO_REPLY_N_NEXT,
 137   .next_nodes = {
 138     [ICMP6_ECHO_REPLY_NEXT_NORMAL] = "error-drop",
 139   },
 140 };
 141 /* *INDENT-ON* */
 142
 143 /*
 144  * Process ICMPv4 echo replies
 145  */
 146 static uword
 147 ip4_icmp_echo_reply_node_fn (vlib_main_t * vm,
 148                              vlib_node_runtime_t * node, vlib_frame_t * frame)
 149 {
 150   u32 n_left_from, *from;
 151
 152   from = vlib_frame_vector_args (frame);        /* array of buffer indices */
 153   n_left_from = frame->n_vectors;       /* number of buffer indices */
 154
 155   while (n_left_from > 0)
 156     {
 157       u32 bi0;
 158       vlib_buffer_t *b0;
 159       u32 next0;
 160
 161       bi0 = from[0];
 162       b0 = vlib_get_buffer (vm, bi0);
 163
 164       /* push this pkt to the next graph node, always error-drop */
 165       signal_ip46_icmp_reply_event (vm, PING_RESPONSE_IP4, b0);
 166
 167       next0 = ICMP4_ECHO_REPLY_NEXT_NORMAL;
 168       vlib_set_next_frame_buffer (vm, node, next0, bi0);
 169
 170       from += 1;
 171       n_left_from -= 1;
 172     }
 173
 174   return frame->n_vectors;
 175 }
 176
 177 /* *INDENT-OFF* */
 178 VLIB_REGISTER_NODE (ip4_icmp_echo_reply_node, static) =
 179 {
 180   .function = ip4_icmp_echo_reply_node_fn,
 181   .name = "ip4-icmp-echo-reply",
 182   .vector_size = sizeof (u32),
 183   .format_trace = format_icmp4_input_trace,
 184   .n_next_nodes = ICMP4_ECHO_REPLY_N_NEXT,
 185   .next_nodes = {
 186     [ICMP4_ECHO_REPLY_NEXT_NORMAL] = "error-drop",
 187   },
 188 };
 189 /* *INDENT-ON* */
 190
 191 char *ip6_lookup_next_nodes[] = IP6_LOOKUP_NEXT_NODES;
 192 char *ip4_lookup_next_nodes[] = IP4_LOOKUP_NEXT_NODES;
 193
 194 /* get first interface address */
 195 static ip6_address_t *
 196 ip6_interface_first_address (ip6_main_t * im, u32 sw_if_index)
 197 {
 198   ip_lookup_main_t *lm = &im->lookup_main;
 199   ip_interface_address_t *ia = 0;
 200   ip6_address_t *result = 0;
 201
 202   foreach_ip_interface_address (lm, ia, sw_if_index,
 203                                 1 /* honor unnumbered */ ,
 204                                 (
 205                                   {
 206                                   ip6_address_t * a =
 207                                   ip_interface_address_get_address (lm, ia);
 208                                   result = a;
 209                                   break;
 210                                   }
 211                                 ));
 212   return result;
 213 }
 214
 215 /* Fill in the ICMP ECHO structure, return the safety-checked and possibly shrunk data_len */
 216 static u16
 217 init_icmp46_echo_request (icmp46_echo_request_t * icmp46_echo,
 218                           u16 seq_host, u16 id_host, u16 data_len)
 219 {
 220   int i;
 221   icmp46_echo->seq = clib_host_to_net_u16 (seq_host);
 222   icmp46_echo->id = clib_host_to_net_u16 (id_host);
 223
 224   for (i = 0; i < sizeof (icmp46_echo->data); i++)
 225     {
 226       icmp46_echo->data[i] = i % 256;
 227     }
 228
 229   if (data_len > sizeof (icmp46_echo_request_t))
 230     {
 231       data_len = sizeof (icmp46_echo_request_t);
 232     }
 233   return data_len;
 234 }
 235
 236 /*
 237  * Given adj index, return sw_if_index, possibly overwritten
 238  * by a parameter. There is mostly debug outputs here,
 239  * but it turned out handy to have these.
 240  */
 241
 242 static u32
 243 adj_index_to_sw_if_index (vlib_main_t * vm, ip_lookup_main_t * lm,
 244                           char *lookup_next_nodes[], u32 adj_index0,
 245                           u32 sw_if_index, u8 verbose)
 246 {
 247   ip_adjacency_t *adj0 = ip_get_adjacency (lm, adj_index0);
 248   u32 sw_if_index0 = adj0->rewrite_header.sw_if_index;
 249   if (verbose)
 250     {
 251       vlib_cli_output (vm, "Adjacency index: %u, sw_if_index: %u\n",
 252                        adj_index0, sw_if_index0);
 253       vlib_cli_output (vm, "Adj: %s\n",
 254                        lookup_next_nodes[adj0->lookup_next_index]);
 255       vlib_cli_output (vm, "Adj Interface: %d\n", adj0->if_address_index);
 256     }
 257
 258   if (~0 != sw_if_index)
 259     {
 260       sw_if_index0 = sw_if_index;
 261       if (verbose)
 262         {
 263           vlib_cli_output (vm, "Forced set interface: %d\n", sw_if_index0);
 264         }
 265     }
 266   return sw_if_index0;
 267 }
 268
 269 static send_ip46_ping_result_t
 270 send_ip6_ping (vlib_main_t * vm, ip6_main_t * im, ip6_address_t * pa6,
 271                u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len,
 272                u8 verbose)
 273 {
 274   icmp6_echo_request_header_t *h0;
 275   u32 bi0 = 0;
 276   u32 sw_if_index0;
 277   ip_lookup_main_t *lm = &im->lookup_main;
 278   int bogus_length = 0;
 279   u32 adj_index0;
 280   vlib_buffer_t *p0;
 281   vlib_frame_t *f;
 282   u32 *to_next;
 283   u32 fib_index0;
 284
 285   if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
 286     return SEND_PING_ALLOC_FAIL;
 287
 288   p0 = vlib_get_buffer (vm, bi0);
 289
 290   /* Determine sw_if_index0 of source intf, may be force-set via sw_if_index. */
 291   vnet_buffer (p0)->sw_if_index[VLIB_RX] = 0;
 292   vnet_buffer (p0)->sw_if_index[VLIB_TX] = ~0;  /* use interface VRF */
 293   fib_index0 = 0;
 294   adj_index0 = fib_entry_get_adj(ip6_fib_table_lookup(fib_index0, pa6, 128));
 295
 296   if (ADJ_INDEX_INVALID == adj_index0)
 297     {
 298       vlib_buffer_free (vm, &bi0, 1);
 299       return SEND_PING_NO_INTERFACE;
 300     }
 301
 302   sw_if_index0 =
 303     adj_index_to_sw_if_index (vm, lm, ip6_lookup_next_nodes, adj_index0,
 304                               sw_if_index, verbose);
 305   if ((~0 == sw_if_index0) && (~0 == sw_if_index))
 306     {
 307       vlib_buffer_free (vm, &bi0, 1);
 308       return SEND_PING_NO_INTERFACE;
 309     }
 310   vnet_buffer (p0)->sw_if_index[VLIB_RX] = sw_if_index0;
 311
 312   h0 = vlib_buffer_get_current (p0);
 313
 314   /* Fill in ip6 header fields */
 315   h0->ip6.ip_version_traffic_class_and_flow_label =
 316     clib_host_to_net_u32 (0x6 << 28);
 317   h0->ip6.payload_length = 0;   /* Set below */
 318   h0->ip6.protocol = IP_PROTOCOL_ICMP6;
 319   h0->ip6.hop_limit = 255;
 320   h0->ip6.dst_address = *pa6;
 321   h0->ip6.src_address = *pa6;
 322
 323   /* Fill in the correct source now */
 324   ip6_address_t *a = ip6_interface_first_address (im, sw_if_index0);
 325   h0->ip6.src_address = a[0];
 326
 327   /* Fill in icmp fields */
 328   h0->icmp.type = ICMP6_echo_request;
 329   h0->icmp.code = 0;
 330   h0->icmp.checksum = 0;
 331
 332   data_len =
 333     init_icmp46_echo_request (&h0->icmp_echo, seq_host, id_host, data_len);
 334   h0->icmp_echo.time_sent = vlib_time_now (vm);
 335
 336   /* Fix up the lengths */
 337   h0->ip6.payload_length =
 338     clib_host_to_net_u16 (data_len + sizeof (icmp46_header_t));
 339
 340   p0->current_length = clib_net_to_host_u16 (h0->ip6.payload_length) +
 341     STRUCT_OFFSET_OF (icmp6_echo_request_header_t, icmp);
 342
 343   /* Calculate the ICMP checksum */
 344   h0->icmp.checksum = 0;
 345   h0->icmp.checksum =
 346     ip6_tcp_udp_icmp_compute_checksum (vm, 0, &h0->ip6, &bogus_length);
 347
 348   /* Enqueue the packet right now */
 349   f = vlib_get_frame_to_node (vm, ip6_lookup_node.index);
 350   to_next = vlib_frame_vector_args (f);
 351   to_next[0] = bi0;
 352   f->n_vectors = 1;
 353   vlib_put_frame_to_node (vm, ip6_lookup_node.index, f);
 354
 355   return SEND_PING_OK;
 356 }
 357
 358 static send_ip46_ping_result_t
 359 send_ip4_ping (vlib_main_t * vm,
 360                ip4_main_t * im,
 361                ip4_address_t * pa4,
 362                u32 sw_if_index,
 363                u16 seq_host, u16 id_host, u16 data_len, u8 verbose)
 364 {
 365   icmp4_echo_request_header_t *h0;
 366   u32 bi0 = 0;
 367   u32 sw_if_index0;
 368   ip_lookup_main_t *lm = &im->lookup_main;
 369   u32 adj_index0;
 370   vlib_buffer_t *p0;
 371   vlib_frame_t *f;
 372   u32 *to_next;
 373   u32 fib_index0;
 374   u32 if_add_index0;
 375
 376   if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
 377     return SEND_PING_ALLOC_FAIL;
 378
 379   p0 = vlib_get_buffer (vm, bi0);
 380
 381   /* Determine sw_if_index0 of the source intf, may be force-set via sw_if_index.  */
 382   vnet_buffer (p0)->sw_if_index[VLIB_RX] = 0;
 383   vnet_buffer (p0)->sw_if_index[VLIB_TX] = ~0;  /* use interface VRF */
 384   fib_index0 = 0;
 385   adj_index0 = fib_entry_get_adj(ip4_fib_table_lookup(
 386                                      ip4_fib_get(fib_index0), pa4, 32));
 387
 388   if (ADJ_INDEX_INVALID == adj_index0)
 389     {
 390       vlib_buffer_free (vm, &bi0, 1);
 391       return SEND_PING_NO_INTERFACE;
 392     }
 393
 394   sw_if_index0 =
 395     adj_index_to_sw_if_index (vm, lm, ip4_lookup_next_nodes, adj_index0,
 396                               sw_if_index, verbose);
 397   if ((~0 == sw_if_index0) && (~0 == sw_if_index))
 398     {
 399       vlib_buffer_free (vm, &bi0, 1);
 400       return SEND_PING_NO_INTERFACE;
 401     }
 402   vnet_buffer (p0)->sw_if_index[VLIB_RX] = sw_if_index0;
 403
 404   h0 = vlib_buffer_get_current (p0);
 405
 406   /* Fill in ip4 header fields */
 407   h0->ip4.checksum = 0;
 408   h0->ip4.ip_version_and_header_length = 0x45;
 409   h0->ip4.tos = 0;
 410   h0->ip4.length = 0;           /* Set below */
 411   h0->ip4.fragment_id = 0;
 412   h0->ip4.flags_and_fragment_offset = 0;
 413   h0->ip4.ttl = 0xff;
 414   h0->ip4.protocol = IP_PROTOCOL_ICMP;
 415   h0->ip4.dst_address = *pa4;
 416   h0->ip4.src_address = *pa4;
 417
 418   /* Fill in the correct source now */
 419   if_add_index0 = lm->if_address_pool_index_by_sw_if_index[sw_if_index0];
 420   if (PREDICT_TRUE (if_add_index0 != ~0))
 421     {
 422       ip_interface_address_t *if_add =
 423         pool_elt_at_index (lm->if_address_pool, if_add_index0);
 424       ip4_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
 425       h0->ip4.src_address = *if_ip;
 426       if (verbose)
 427         {
 428           vlib_cli_output (vm, "Source address: %U",
 429                            format_ip4_address, &h0->ip4.src_address);
 430         }
 431     }
 432
 433   /* Fill in icmp fields */
 434   h0->icmp.type = ICMP4_echo_request;
 435   h0->icmp.code = 0;
 436   h0->icmp.checksum = 0;
 437
 438   data_len =
 439     init_icmp46_echo_request (&h0->icmp_echo, seq_host, id_host, data_len);
 440   h0->icmp_echo.time_sent = vlib_time_now (vm);
 441
 442   /* Fix up the lengths */
 443   h0->ip4.length =
 444     clib_host_to_net_u16 (data_len + sizeof (icmp46_header_t) +
 445                           sizeof (ip4_header_t));
 446
 447   p0->current_length = clib_net_to_host_u16 (h0->ip4.length);
 448
 449   /* Calculate the IP and ICMP checksums */
 450   h0->ip4.checksum = ip4_header_checksum (&(h0->ip4));
 451   h0->icmp.checksum =
 452     ~ip_csum_fold (ip_incremental_checksum (0, &(h0->icmp),
 453                     p0->current_length - sizeof (ip4_header_t)));
 454
 455   /* Enqueue the packet right now */
 456   f = vlib_get_frame_to_node (vm, ip4_lookup_node.index);
 457   to_next = vlib_frame_vector_args (f);
 458   to_next[0] = bi0;
 459   f->n_vectors = 1;
 460   vlib_put_frame_to_node (vm, ip4_lookup_node.index, f);
 461
 462   return SEND_PING_OK;
 463 }
 464
 465
 466 static void
 467 print_ip6_icmp_reply (vlib_main_t * vm, u32 bi0)
 468 {
 469   vlib_buffer_t *b0 = vlib_get_buffer (vm,
 470                                        bi0);
 471   icmp6_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
 472   f64 rtt = vlib_time_now (vm) - h0->icmp_echo.time_sent;
 473
 474   vlib_cli_output (vm,
 475                    "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
 476                    clib_host_to_net_u16 (h0->ip6.payload_length),
 477                    format_ip6_address,
 478                    &h0->ip6.src_address,
 479                    clib_host_to_net_u16 (h0->icmp_echo.seq),
 480                    h0->ip6.hop_limit, rtt * 1000.0);
 481 }
 482
 483 static void
 484 print_ip4_icmp_reply (vlib_main_t * vm, u32 bi0)
 485 {
 486   vlib_buffer_t *b0 = vlib_get_buffer (vm,
 487                                        bi0);
 488   icmp4_echo_request_header_t *h0 = vlib_buffer_get_current (b0);
 489   f64 rtt = vlib_time_now (vm) - h0->icmp_echo.time_sent;
 490   u32 rcvd_icmp_len =
 491     clib_host_to_net_u16 (h0->ip4.length) -
 492     (4 * (0xF & h0->ip4.ip_version_and_header_length));
 493
 494   vlib_cli_output (vm,
 495                    "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
 496                    rcvd_icmp_len,
 497                    format_ip4_address,
 498                    &h0->ip4.src_address,
 499                    clib_host_to_net_u16 (h0->icmp_echo.seq),
 500                    h0->ip4.ttl, rtt * 1000.0);
 501 }
 502
 503
 504 /*
 505  * Perform the ping run with the given parameters in the current CLI process.
 506  * Depending on whether pa4 or pa6 is set, runs IPv4 or IPv6 ping.
 507  * The amusing side effect is of course if both are set, then both pings are sent.
 508  * This behavior can be used to ping a dualstack host over IPv4 and IPv6 at once.
 509  */
 510
 511 static void
 512 run_ping_ip46_address (vlib_main_t * vm, ip4_address_t * pa4,
 513                        ip6_address_t * pa6, u32 sw_if_index,
 514                        f64 ping_interval, u32 ping_repeat, u32 data_len,
 515                        u32 verbose)
 516 {
 517   int i;
 518   ping_main_t *pm = &ping_main;
 519   uword curr_proc = vlib_current_process (vm);
 520   u32 n_replies = 0;
 521   u32 n_requests = 0;
 522   ping_run_t *pr = 0;
 523   u32 ping_run_index = 0;
 524   u16 icmp_id;
 525
 526   static u32 rand_seed = 0;
 527
 528   if (PREDICT_FALSE(!rand_seed))
 529       rand_seed = random_default_seed();
 530
 531   icmp_id = random_u32(&rand_seed) & 0xffff;
 532
 533   while (hash_get (pm->ping_run_by_icmp_id, icmp_id))
 534     {
 535       vlib_cli_output (vm, "ICMP ID collision at %d, incrementing", icmp_id);
 536       icmp_id++;
 537     }
 538   pool_get (pm->ping_runs, pr);
 539   ping_run_index = pr - pm->ping_runs;
 540   pr->cli_process_id = curr_proc;
 541   pr->icmp_id = icmp_id;
 542   hash_set (pm->ping_run_by_icmp_id, icmp_id, ping_run_index);
 543   for (i = 1; i <= ping_repeat; i++)
 544     {
 545       f64 sleep_interval;
 546       f64 time_ping_sent = vlib_time_now (vm);
 547       /* Reset pr: running ping in other process could have changed pm->ping_runs */
 548       pr = vec_elt_at_index (pm->ping_runs, ping_run_index);
 549       pr->curr_seq = i;
 550       if (pa6 &&
 551           (SEND_PING_OK == send_ip6_ping (vm, ping_main.ip6_main, pa6,
 552                                           sw_if_index, i, icmp_id, data_len,
 553                                           verbose)))
 554         {
 555           n_requests++;
 556         }
 557       if (pa4 &&
 558           (SEND_PING_OK == send_ip4_ping (vm, ping_main.ip4_main, pa4,
 559                                           sw_if_index, i, icmp_id, data_len,
 560                                           verbose)))
 561         {
 562           n_requests++;
 563         }
 564       while ((i <= ping_repeat)
 565              &&
 566              ((sleep_interval =
 567                time_ping_sent + ping_interval - vlib_time_now (vm)) > 0.0))
 568         {
 569           uword event_type, *event_data = 0;
 570           vlib_process_wait_for_event_or_clock (vm, sleep_interval);
 571           event_type = vlib_process_get_events (vm, &event_data);
 572           switch (event_type)
 573             {
 574             case ~0:           /* no events => timeout */
 575               break;
 576             case PING_RESPONSE_IP6:
 577               {
 578                 int i;
 579                 for (i = 0; i < vec_len (event_data); i++)
 580                   {
 581                     u32 bi0 = event_data[0];
 582                     print_ip6_icmp_reply (vm, bi0);
 583                     n_replies++;
 584                     if (0 != bi0)
 585                       {
 586                         vlib_buffer_free (vm, &bi0, 1);
 587                       }
 588                   }
 589               }
 590               break;
 591             case PING_RESPONSE_IP4:
 592               {
 593                 int i;
 594                 for (i = 0; i < vec_len (event_data); i++)
 595                   {
 596                     u32 bi0 = event_data[0];
 597                     print_ip4_icmp_reply (vm, bi0);
 598                     n_replies++;
 599                     if (0 != bi0)
 600                       {
 601                         vlib_buffer_free (vm, &bi0, 1);
 602                       }
 603                   }
 604               }
 605               break;
 606             default:
 607               /* someone pressed a key, abort */
 608               vlib_cli_output (vm, "Aborted due to a keypress.");
 609               i = 1 + ping_repeat;
 610               break;
 611             }
 612         }
 613     }
 614   vlib_cli_output (vm, "\n");
 615   {
 616     float loss =
 617       (0 ==
 618        n_requests) ? 0 : 100.0 * ((float) n_requests -
 619                                   (float) n_replies) / (float) n_requests;
 620     vlib_cli_output (vm,
 621                      "Statistics: %u sent, %u received, %f%% packet loss\n",
 622                      n_requests, n_replies, loss);
 623     /* Reset pr: running ping in other process could have changed pm->ping_runs */
 624     pr = vec_elt_at_index (pm->ping_runs, ping_run_index);
 625     hash_unset (pm->ping_run_by_icmp_id, icmp_id);
 626     pool_put (pm->ping_runs, pr);
 627   }
 628 }
 629
 630
 631
 632
 633
 634 static clib_error_t *
 635 ping_ip_address (vlib_main_t * vm,
 636                  unformat_input_t * input, vlib_cli_command_t * cmd)
 637 {
 638   ip4_address_t a4;
 639   ip6_address_t a6;
 640   clib_error_t *error = 0;
 641   u32 ping_repeat = 5;
 642   u8 ping_ip4, ping_ip6;
 643   vnet_main_t *vnm = vnet_get_main ();
 644   u32 data_len = PING_DEFAULT_DATA_LEN;
 645   u32 verbose = 0;
 646   f64 ping_interval = PING_DEFAULT_INTERVAL;
 647   ping_ip4 = ping_ip6 = 0;
 648   u32 sw_if_index;
 649   sw_if_index = ~0;
 650   if (unformat (input, "%U", unformat_ip4_address, &a4))
 651     {
 652       ping_ip4 = 1;
 653     }
 654   else if (unformat (input, "%U", unformat_ip6_address, &a6))
 655     {
 656       ping_ip6 = 1;
 657     }
 658   else if (unformat (input, "ipv4"))
 659     {
 660       if (unformat (input, "%U", unformat_ip4_address, &a4))
 661         {
 662           ping_ip4 = 1;
 663         }
 664       else
 665         {
 666           error =
 667             clib_error_return (0,
 668                                "expecting IPv4 address but got `%U'",
 669                                format_unformat_error, input);
 670         }
 671     }
 672   else if (unformat (input, "ipv6"))
 673     {
 674       if (unformat (input, "%U", unformat_ip6_address, &a6))
 675         {
 676           ping_ip6 = 1;
 677         }
 678       else
 679         {
 680           error =
 681             clib_error_return (0,
 682                                "expecting IPv6 address but got `%U'",
 683                                format_unformat_error, input);
 684         }
 685     }
 686   else
 687     {
 688       error =
 689         clib_error_return (0,
 690                            "expecting IP4/IP6 address `%U'. Usage: ping <addr> [source <intf>] [size <datasz>] [repeat <count>] [verbose]",
 691                            format_unformat_error, input);
 692       goto done;
 693     }
 694
 695   /* allow for the second AF in the same ping */
 696   if (!ping_ip4 && (unformat (input, "ipv4")))
 697     {
 698       if (unformat (input, "%U", unformat_ip4_address, &a4))
 699         {
 700           ping_ip4 = 1;
 701         }
 702     }
 703   else if (!ping_ip6 && (unformat (input, "ipv6")))
 704     {
 705       if (unformat (input, "%U", unformat_ip6_address, &a6))
 706         {
 707           ping_ip6 = 1;
 708         }
 709     }
 710
 711   /* parse the rest of the parameters  in a cycle */
 712   while (!unformat_eof (input, NULL))
 713     {
 714       if (unformat (input, "source"))
 715         {
 716           if (!unformat_user
 717               (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 718             {
 719               error =
 720                 clib_error_return (0,
 721                                    "unknown interface `%U'",
 722                                    format_unformat_error, input);
 723               goto done;
 724             }
 725         }
 726       else if (unformat (input, "size"))
 727         {
 728           if (!unformat (input, "%u", &data_len))
 729             {
 730               error =
 731                 clib_error_return (0,
 732                                    "expecting size but got `%U'",
 733                                    format_unformat_error, input);
 734               goto done;
 735             }
 736         }
 737       else if (unformat (input, "interval"))
 738         {
 739           if (!unformat (input, "%f", &ping_interval))
 740             {
 741               error =
 742                 clib_error_return (0,
 743                                    "expecting interval (floating point number) got `%U'",
 744                                    format_unformat_error, input);
 745               goto done;
 746             }
 747         }
 748       else if (unformat (input, "repeat"))
 749         {
 750           if (!unformat (input, "%u", &ping_repeat))
 751             {
 752               error =
 753                 clib_error_return (0,
 754                                    "expecting repeat count but got `%U'",
 755                                    format_unformat_error, input);
 756               goto done;
 757             }
 758         }
 759       else if (unformat (input, "verbose"))
 760         {
 761           verbose = 1;
 762         }
 763       else
 764         {
 765           error = clib_error_return (0, "unknown input `%U'",
 766                                      format_unformat_error, input);
 767           goto done;
 768         }
 769     }
 770
 771   run_ping_ip46_address (vm, ping_ip4 ? &a4 : NULL, ping_ip6 ? &a6 : NULL,
 772                          sw_if_index, ping_interval, ping_repeat, data_len,
 773                          verbose);
 774 done:
 775   return error;
 776 }
 777
 778 /*?
 779  * This command sends an ICMP ECHO_REQUEST to network hosts. The address
 780  * can be an IPv4 or IPv6 address (or both at the same time).
 781  *
 782  * @cliexpar
 783  * @parblock
 784  * Example of how ping an IPv4 address:
 785  * @cliexstart{ping 172.16.1.2 source GigabitEthernet2/0/0 repeat 2}
 786  * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1090 ms
 787  * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0914 ms
 788  *
 789  * Statistics: 2 sent, 2 received, 0% packet loss
 790  * @cliexend
 791  *
 792  * Example of how ping both an IPv4 address and IPv6 address at the same time:
 793  * @cliexstart{ping 172.16.1.2 ipv6 fe80::24a5:f6ff:fe9c:3a36 source GigabitEthernet2/0/0 repeat 2 verbose}
 794  * Adjacency index: 10, sw_if_index: 1
 795  * Adj: ip6-discover-neighbor
 796  * Adj Interface: 0
 797  * Forced set interface: 1
 798  * Adjacency index: 0, sw_if_index: 4294967295
 799  * Adj: ip4-miss
 800  * Adj Interface: 0
 801  * Forced set interface: 1
 802  * Source address: 172.16.1.1
 803  * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1899 ms
 804  * Adjacency index: 10, sw_if_index: 1
 805  * Adj: ip6-discover-neighbor
 806  * Adj Interface: 0
 807  * Forced set interface: 1
 808  * Adjacency index: 0, sw_if_index: 4294967295
 809  * Adj: ip4-miss
 810  * Adj Interface: 0
 811  * Forced set interface: 1
 812  * Source address: 172.16.1.1
 813  * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0910 ms
 814  *
 815  * Statistics: 4 sent, 2 received, 50% packet loss
 816  * @cliexend
 817  * @endparblock
 818 ?*/
 819 /* *INDENT-OFF* */
 820 VLIB_CLI_COMMAND (ping_command, static) =
 821 {
 822   .path = "ping",
 823   .function = ping_ip_address,
 824   .short_help = "ping {<ip-addr> | ipv4 <ip4-addr> | ipv6 <ip6-addr>} [ipv4 <ip4-addr> | ipv6 <ip6-addr>] [source <interface>] [size <pktsize>] [interval <sec>] [repeat <cnt>] [verbose]",
 825 };
 826 /* *INDENT-ON* */
 827
 828 static clib_error_t *
 829 ping_cli_init (vlib_main_t * vm)
 830 {
 831   ping_main_t *pm = &ping_main;
 832   pm->ip6_main = &ip6_main;
 833   pm->ip4_main = &ip4_main;
 834   icmp6_register_type (vm, ICMP6_echo_reply, ip6_icmp_echo_reply_node.index);
 835   ip4_icmp_register_type (vm, ICMP4_echo_reply,
 836                           ip4_icmp_echo_reply_node.index);
 837   return 0;
 838 }
 839
 840 VLIB_INIT_FUNCTION (ping_cli_init);