src/plugins/ping/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 <stddef.h>
  17
  18 #include <vlib/vlib.h>
  19 #include <vlib/unix/unix.h>
  20 #include <vnet/fib/ip6_fib.h>
  21 #include <vnet/fib/ip4_fib.h>
  22 #include <vnet/ip/ip_sas.h>
  23 #include <vnet/ip/ip6_link.h>
  24 #include <vnet/ip/ip6_ll_table.h>
  25 #include <vnet/plugin/plugin.h>
  26 #include <vpp/app/version.h>
  27
  28 #include <vnet/ip/icmp4.h>
  29 #include <ping/ping.h>
  30
  31 ping_main_t ping_main;
  32
  33 /**
  34  * @file
  35  * @brief IPv4 and IPv6 ICMP Ping.
  36  *
  37  * This file contains code to support IPv4 or IPv6 ICMP ECHO_REQUEST to
  38  * network hosts.
  39  *
  40  */
  41
  42 typedef struct
  43 {
  44   u16 id;
  45   u16 seq;
  46   u32 cli_process_node;
  47   u8 is_ip6;
  48 } icmp_echo_trace_t;
  49
  50
  51 u8 *
  52 format_icmp_echo_trace (u8 * s, va_list * va)
  53 {
  54   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
  55   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
  56   icmp_echo_trace_t *t = va_arg (*va, icmp_echo_trace_t *);
  57
  58   s =
  59     format (s, "ICMP%s echo id %d seq %d", t->is_ip6 ? "6" : "4", t->id,
  60             t->seq);
  61   if (t->cli_process_node == PING_CLI_UNKNOWN_NODE)
  62     {
  63       s = format (s, " (unknown)");
  64     }
  65   else
  66     {
  67       s = format (s, " send to cli node %d", t->cli_process_node);
  68     }
  69
  70   return s;
  71 }
  72
  73
  74 static u8 *
  75 format_ip46_ping_result (u8 * s, va_list * args)
  76 {
  77   send_ip46_ping_result_t res = va_arg (*args, send_ip46_ping_result_t);
  78
  79   switch (res)
  80     {
  81 #define _(v, n) case SEND_PING_##v: s = format(s, "%s", n);break;
  82       foreach_ip46_ping_result
  83 #undef _
  84     }
  85
  86   return (s);
  87 }
  88
  89
  90 /*
  91  * Poor man's get-set-clear functions
  92  * for manipulation of icmp_id -> cli_process_id
  93  * mappings.
  94  *
  95  * There should normally be very few (0..1..2) of these
  96  * mappings, so the linear search is a good strategy.
  97  *
  98  * Make them thread-safe via a simple spinlock.
  99  *
 100  */
 101
 102
 103 static_always_inline uword
 104 get_cli_process_id_by_icmp_id_mt (vlib_main_t * vm, u16 icmp_id)
 105 {
 106   ping_main_t *pm = &ping_main;
 107   uword cli_process_id = PING_CLI_UNKNOWN_NODE;
 108   ping_run_t *pr;
 109
 110   clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
 111   vec_foreach (pr, pm->active_ping_runs)
 112   {
 113     if (pr->icmp_id == icmp_id)
 114       {
 115         cli_process_id = pr->cli_process_id;
 116         break;
 117       }
 118   }
 119   clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
 120   return cli_process_id;
 121 }
 122
 123
 124 static_always_inline void
 125 set_cli_process_id_by_icmp_id_mt (vlib_main_t * vm, u16 icmp_id,
 126                                   uword cli_process_id)
 127 {
 128   ping_main_t *pm = &ping_main;
 129   ping_run_t *pr;
 130
 131   clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
 132   vec_foreach (pr, pm->active_ping_runs)
 133   {
 134     if (pr->icmp_id == icmp_id)
 135       {
 136         pr->cli_process_id = cli_process_id;
 137         goto have_found_and_set;
 138       }
 139   }
 140   /* no such key yet - add a new one */
 141   ping_run_t new_pr = {.icmp_id = icmp_id,.cli_process_id = cli_process_id };
 142   vec_add1 (pm->active_ping_runs, new_pr);
 143 have_found_and_set:
 144   clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
 145 }
 146
 147
 148 static_always_inline void
 149 clear_cli_process_id_by_icmp_id_mt (vlib_main_t * vm, u16 icmp_id)
 150 {
 151   ping_main_t *pm = &ping_main;
 152   ping_run_t *pr;
 153
 154   clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
 155   vec_foreach (pr, pm->active_ping_runs)
 156   {
 157     if (pr->icmp_id == icmp_id)
 158       {
 159         vec_del1 (pm->active_ping_runs, pm->active_ping_runs - pr);
 160         break;
 161       }
 162   }
 163   clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
 164 }
 165
 166 static_always_inline int
 167 ip46_get_icmp_id_and_seq (vlib_main_t * vm, vlib_buffer_t * b0,
 168                           u16 * out_icmp_id, u16 * out_icmp_seq, int is_ip6)
 169 {
 170   int l4_offset;
 171   if (is_ip6)
 172     {
 173       ip6_header_t *ip6 = vlib_buffer_get_current (b0);
 174       if (ip6->protocol != IP_PROTOCOL_ICMP6)
 175         {
 176           return 0;
 177         }
 178       l4_offset = sizeof (*ip6);        // IPv6 EH
 179     }
 180   else
 181     {
 182       ip4_header_t *ip4 = vlib_buffer_get_current (b0);
 183       l4_offset = ip4_header_bytes (ip4);
 184
 185     }
 186   icmp46_header_t *icmp46 = vlib_buffer_get_current (b0) + l4_offset;
 187   icmp46_echo_request_t *icmp46_echo = (icmp46_echo_request_t *) (icmp46 + 1);
 188
 189   *out_icmp_id = clib_net_to_host_u16 (icmp46_echo->id);
 190   *out_icmp_seq = clib_net_to_host_u16 (icmp46_echo->seq);
 191   return 1;
 192 }
 193
 194 /*
 195  * post the buffer to a given cli process node - the caller should forget bi0 after return.
 196  */
 197
 198 static_always_inline void
 199 ip46_post_icmp_reply_event (vlib_main_t * vm, uword cli_process_id, u32 bi0,
 200                             int is_ip6)
 201 {
 202   vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
 203   u64 nowts = clib_cpu_time_now ();
 204
 205   /* Pass the timestamp to the cli_process thanks to the vnet_buffer unused metadata field */
 206
 207   /* Camping on unused data... just ensure statically that there is enough space */
 208   STATIC_ASSERT (ARRAY_LEN (vnet_buffer (b0)->unused) *
 209                  sizeof (vnet_buffer (b0)->unused[0]) > sizeof (nowts),
 210                  "ping reply timestamp fits within remaining space of vnet_buffer unused data");
 211   u64 *pnowts = (void *) &vnet_buffer (b0)->unused[0];
 212   *pnowts = nowts;
 213
 214   u32 event_id = is_ip6 ? PING_RESPONSE_IP6 : PING_RESPONSE_IP4;
 215   vlib_process_signal_event_mt (vm, cli_process_id, event_id, bi0);
 216 }
 217
 218
 219 static_always_inline void
 220 ip46_echo_reply_maybe_trace_buffer (vlib_main_t * vm,
 221                                     vlib_node_runtime_t * node,
 222                                     uword cli_process_id, u16 id, u16 seq,
 223                                     vlib_buffer_t * b0, int is_ip6)
 224 {
 225   if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
 226     {
 227       icmp_echo_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
 228       tr->id = id;
 229       tr->seq = seq;
 230       tr->cli_process_node = cli_process_id;
 231       tr->is_ip6 = is_ip6;
 232     }
 233 }
 234
 235
 236 static_always_inline uword
 237 ip46_icmp_echo_reply_inner_node_fn (vlib_main_t * vm,
 238                                     vlib_node_runtime_t * node,
 239                                     vlib_frame_t * frame, int do_trace,
 240                                     int is_ip6)
 241 {
 242   u32 n_left_from, *from, *to_next;
 243   icmp46_echo_reply_next_t next_index;
 244
 245   from = vlib_frame_vector_args (frame);
 246   n_left_from = frame->n_vectors;
 247
 248   next_index = node->cached_next_index;
 249
 250   while (n_left_from > 0)
 251     {
 252       u32 n_left_to_next;
 253       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 254
 255       while (n_left_from > 0 && n_left_to_next > 0)
 256         {
 257           u32 bi0;
 258           vlib_buffer_t *b0;
 259           /*
 260            * The buffers (replies) are either posted to the CLI thread
 261            * awaiting for them for subsequent analysis and disposal,
 262            * or are sent to the punt node.
 263            *
 264            * So the only "next" node is a punt, normally.
 265            */
 266           u32 next0 = ICMP46_ECHO_REPLY_NEXT_PUNT;
 267
 268           bi0 = from[0];
 269           b0 = vlib_get_buffer (vm, bi0);
 270           from += 1;
 271           n_left_from -= 1;
 272
 273           u16 icmp_id = ~0;
 274           u16 icmp_seq = ~0;
 275           uword cli_process_id = PING_CLI_UNKNOWN_NODE;
 276
 277           if (ip46_get_icmp_id_and_seq (vm, b0, &icmp_id, &icmp_seq, is_ip6))
 278             {
 279               cli_process_id = get_cli_process_id_by_icmp_id_mt (vm, icmp_id);
 280             }
 281
 282           if (do_trace)
 283             ip46_echo_reply_maybe_trace_buffer (vm, node, cli_process_id,
 284                                                 icmp_id, icmp_seq, b0,
 285                                                 is_ip6);
 286
 287           if (~0 == cli_process_id)
 288             {
 289               /* no outstanding requests for this reply, punt */
 290               /* speculatively enqueue b0 to the current next frame */
 291               to_next[0] = bi0;
 292               to_next += 1;
 293               n_left_to_next -= 1;
 294               /* verify speculative enqueue, maybe switch current next frame */
 295               vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 296                                                to_next, n_left_to_next,
 297                                                bi0, next0);
 298             }
 299           else
 300             {
 301               /* Post the buffer to CLI thread. It will take care of freeing it. */
 302               ip46_post_icmp_reply_event (vm, cli_process_id, bi0, is_ip6);
 303             }
 304         }
 305       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 306     }
 307   return frame->n_vectors;
 308 }
 309
 310 /*
 311  * select "with-trace" or "without-trace" codepaths upfront.
 312  */
 313 static_always_inline uword
 314 ip46_icmp_echo_reply_outer_node_fn (vlib_main_t * vm,
 315                                     vlib_node_runtime_t * node,
 316                                     vlib_frame_t * frame, int is_ip6)
 317 {
 318   if (node->flags & VLIB_NODE_FLAG_TRACE)
 319     return ip46_icmp_echo_reply_inner_node_fn (vm, node, frame,
 320                                                1 /* do_trace */ , is_ip6);
 321   else
 322     return ip46_icmp_echo_reply_inner_node_fn (vm, node, frame,
 323                                                0 /* do_trace */ , is_ip6);
 324 }
 325
 326 static uword
 327 ip4_icmp_echo_reply_node_fn (vlib_main_t * vm,
 328                              vlib_node_runtime_t * node, vlib_frame_t * frame)
 329 {
 330   return ip46_icmp_echo_reply_outer_node_fn (vm, node, frame,
 331                                              0 /* is_ip6 */ );
 332 }
 333
 334 static uword
 335 ip6_icmp_echo_reply_node_fn (vlib_main_t * vm,
 336                              vlib_node_runtime_t * node, vlib_frame_t * frame)
 337 {
 338   return ip46_icmp_echo_reply_outer_node_fn (vm, node, frame,
 339                                              1 /* is_ip6 */ );
 340 }
 341
 342 /* *INDENT-OFF* */
 343 VLIB_REGISTER_NODE (ip6_icmp_echo_reply_node, static) =
 344 {
 345   .function = ip6_icmp_echo_reply_node_fn,
 346   .name = "ip6-icmp-echo-reply",
 347   .vector_size = sizeof (u32),
 348   .format_trace = format_icmp_echo_trace,
 349   .n_next_nodes = ICMP46_ECHO_REPLY_N_NEXT,
 350   .next_nodes = {
 351     [ICMP46_ECHO_REPLY_NEXT_DROP] = "ip6-drop",
 352     [ICMP46_ECHO_REPLY_NEXT_PUNT] = "ip6-punt",
 353   },
 354 };
 355
 356 VLIB_REGISTER_NODE (ip4_icmp_echo_reply_node, static) =
 357 {
 358   .function = ip4_icmp_echo_reply_node_fn,
 359   .name = "ip4-icmp-echo-reply",
 360   .vector_size = sizeof (u32),
 361   .format_trace = format_icmp_echo_trace,
 362   .n_next_nodes = ICMP46_ECHO_REPLY_N_NEXT,
 363   .next_nodes = {
 364     [ICMP46_ECHO_REPLY_NEXT_DROP] = "ip4-drop",
 365     [ICMP46_ECHO_REPLY_NEXT_PUNT] = "ip4-punt",
 366   },
 367 };
 368 /* *INDENT-ON* */
 369
 370 static uword
 371 ip4_icmp_echo_request (vlib_main_t * vm,
 372                        vlib_node_runtime_t * node, vlib_frame_t * frame)
 373 {
 374   uword n_packets = frame->n_vectors;
 375   u32 *from, *to_next;
 376   u32 n_left_from, n_left_to_next, next;
 377   ip4_main_t *i4m = &ip4_main;
 378   u16 *fragment_ids, *fid;
 379   u8 host_config_ttl = i4m->host_config.ttl;
 380
 381   from = vlib_frame_vector_args (frame);
 382   n_left_from = n_packets;
 383   next = node->cached_next_index;
 384
 385   if (node->flags & VLIB_NODE_FLAG_TRACE)
 386     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 387                                    /* stride */ 1,
 388                                    sizeof (icmp_input_trace_t));
 389
 390   /* Get random fragment IDs for replies. */
 391   fid = fragment_ids = clib_random_buffer_get_data (&vm->random_buffer,
 392                                                     n_packets *
 393                                                     sizeof (fragment_ids[0]));
 394
 395   while (n_left_from > 0)
 396     {
 397       vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
 398
 399       while (n_left_from > 2 && n_left_to_next > 2)
 400         {
 401           vlib_buffer_t *p0, *p1;
 402           ip4_header_t *ip0, *ip1;
 403           icmp46_header_t *icmp0, *icmp1;
 404           u32 bi0, src0, dst0;
 405           u32 bi1, src1, dst1;
 406           ip_csum_t sum0, sum1;
 407
 408           bi0 = to_next[0] = from[0];
 409           bi1 = to_next[1] = from[1];
 410
 411           from += 2;
 412           n_left_from -= 2;
 413           to_next += 2;
 414           n_left_to_next -= 2;
 415
 416           p0 = vlib_get_buffer (vm, bi0);
 417           p1 = vlib_get_buffer (vm, bi1);
 418           ip0 = vlib_buffer_get_current (p0);
 419           ip1 = vlib_buffer_get_current (p1);
 420           icmp0 = ip4_next_header (ip0);
 421           icmp1 = ip4_next_header (ip1);
 422
 423           vnet_buffer (p0)->sw_if_index[VLIB_RX] =
 424             vnet_main.local_interface_sw_if_index;
 425           vnet_buffer (p1)->sw_if_index[VLIB_RX] =
 426             vnet_main.local_interface_sw_if_index;
 427
 428           /* Update ICMP checksum. */
 429           sum0 = icmp0->checksum;
 430           sum1 = icmp1->checksum;
 431
 432           ASSERT (icmp0->type == ICMP4_echo_request);
 433           ASSERT (icmp1->type == ICMP4_echo_request);
 434           sum0 = ip_csum_update (sum0, ICMP4_echo_request, ICMP4_echo_reply,
 435                                  icmp46_header_t, type);
 436           sum1 = ip_csum_update (sum1, ICMP4_echo_request, ICMP4_echo_reply,
 437                                  icmp46_header_t, type);
 438           icmp0->type = ICMP4_echo_reply;
 439           icmp1->type = ICMP4_echo_reply;
 440
 441           icmp0->checksum = ip_csum_fold (sum0);
 442           icmp1->checksum = ip_csum_fold (sum1);
 443
 444           src0 = ip0->src_address.data_u32;
 445           src1 = ip1->src_address.data_u32;
 446           dst0 = ip0->dst_address.data_u32;
 447           dst1 = ip1->dst_address.data_u32;
 448
 449           /* Swap source and destination address.
 450              Does not change checksum. */
 451           ip0->src_address.data_u32 = dst0;
 452           ip1->src_address.data_u32 = dst1;
 453           ip0->dst_address.data_u32 = src0;
 454           ip1->dst_address.data_u32 = src1;
 455
 456           /* Update IP checksum. */
 457           sum0 = ip0->checksum;
 458           sum1 = ip1->checksum;
 459
 460           sum0 = ip_csum_update (sum0, ip0->ttl, host_config_ttl,
 461                                  ip4_header_t, ttl);
 462           sum1 = ip_csum_update (sum1, ip1->ttl, host_config_ttl,
 463                                  ip4_header_t, ttl);
 464           ip0->ttl = host_config_ttl;
 465           ip1->ttl = host_config_ttl;
 466
 467           /* New fragment id. */
 468           sum0 = ip_csum_update (sum0, ip0->fragment_id, fid[0],
 469                                  ip4_header_t, fragment_id);
 470           sum1 = ip_csum_update (sum1, ip1->fragment_id, fid[1],
 471                                  ip4_header_t, fragment_id);
 472           ip0->fragment_id = fid[0];
 473           ip1->fragment_id = fid[1];
 474           fid += 2;
 475
 476           ip0->checksum = ip_csum_fold (sum0);
 477           ip1->checksum = ip_csum_fold (sum1);
 478
 479           ASSERT (ip4_header_checksum_is_valid (ip0));
 480           ASSERT (ip4_header_checksum_is_valid (ip1));
 481
 482           p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 483           p1->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 484         }
 485
 486       while (n_left_from > 0 && n_left_to_next > 0)
 487         {
 488           vlib_buffer_t *p0;
 489           ip4_header_t *ip0;
 490           icmp46_header_t *icmp0;
 491           u32 bi0, src0, dst0;
 492           ip_csum_t sum0;
 493
 494           bi0 = to_next[0] = from[0];
 495
 496           from += 1;
 497           n_left_from -= 1;
 498           to_next += 1;
 499           n_left_to_next -= 1;
 500
 501           p0 = vlib_get_buffer (vm, bi0);
 502           ip0 = vlib_buffer_get_current (p0);
 503           icmp0 = ip4_next_header (ip0);
 504
 505           vnet_buffer (p0)->sw_if_index[VLIB_RX] =
 506             vnet_main.local_interface_sw_if_index;
 507
 508           /* Update ICMP checksum. */
 509           sum0 = icmp0->checksum;
 510
 511           ASSERT (icmp0->type == ICMP4_echo_request);
 512           sum0 = ip_csum_update (sum0, ICMP4_echo_request, ICMP4_echo_reply,
 513                                  icmp46_header_t, type);
 514           icmp0->type = ICMP4_echo_reply;
 515           icmp0->checksum = ip_csum_fold (sum0);
 516
 517           src0 = ip0->src_address.data_u32;
 518           dst0 = ip0->dst_address.data_u32;
 519           ip0->src_address.data_u32 = dst0;
 520           ip0->dst_address.data_u32 = src0;
 521
 522           /* Update IP checksum. */
 523           sum0 = ip0->checksum;
 524
 525           sum0 = ip_csum_update (sum0, ip0->ttl, host_config_ttl,
 526                                  ip4_header_t, ttl);
 527           ip0->ttl = host_config_ttl;
 528
 529           sum0 = ip_csum_update (sum0, ip0->fragment_id, fid[0],
 530                                  ip4_header_t, fragment_id);
 531           ip0->fragment_id = fid[0];
 532           fid += 1;
 533
 534           ip0->checksum = ip_csum_fold (sum0);
 535
 536           ASSERT (ip4_header_checksum_is_valid (ip0));
 537
 538           p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 539         }
 540
 541       vlib_put_next_frame (vm, node, next, n_left_to_next);
 542     }
 543
 544   vlib_error_count (vm, ip4_icmp_input_node.index,
 545                     ICMP4_ERROR_ECHO_REPLIES_SENT, frame->n_vectors);
 546
 547   return frame->n_vectors;
 548 }
 549
 550 static u8 *
 551 format_icmp_input_trace (u8 * s, va_list * va)
 552 {
 553   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
 554   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
 555   icmp_input_trace_t *t = va_arg (*va, icmp_input_trace_t *);
 556
 557   s = format (s, "%U",
 558               format_ip4_header, t->packet_data, sizeof (t->packet_data));
 559
 560   return s;
 561 }
 562
 563 /* *INDENT-OFF* */
 564 VLIB_REGISTER_NODE (ip4_icmp_echo_request_node,static) = {
 565   .function = ip4_icmp_echo_request,
 566   .name = "ip4-icmp-echo-request",
 567
 568   .vector_size = sizeof (u32),
 569
 570   .format_trace = format_icmp_input_trace,
 571
 572   .n_next_nodes = 1,
 573   .next_nodes = {
 574     [0] = "ip4-load-balance",
 575   },
 576 };
 577 /* *INDENT-ON* */
 578
 579 /*
 580  * A swarm of address-family agnostic helper functions
 581  * for building and sending the ICMP echo request.
 582  *
 583  * Deliberately mostly "static" rather than "static inline"
 584  * so one can trace them sanely if needed in debugger, if needed.
 585  *
 586  */
 587
 588 static_always_inline u8
 589 get_icmp_echo_payload_byte (int offset)
 590 {
 591   return (offset % 256);
 592 }
 593
 594 /* Fill in the ICMP ECHO structure, return the safety-checked and possibly shrunk data_len */
 595 static u16
 596 init_icmp46_echo_request (vlib_main_t * vm, vlib_buffer_t * b0,
 597                           int l4_header_offset,
 598                           icmp46_echo_request_t * icmp46_echo, u16 seq_host,
 599                           u16 id_host, u64 now, u16 data_len)
 600 {
 601   int i;
 602
 603
 604   int l34_len =
 605     l4_header_offset + sizeof (icmp46_header_t) +
 606     offsetof (icmp46_echo_request_t, data);
 607   int max_data_len = vlib_buffer_get_default_data_size (vm) - l34_len;
 608
 609   int first_buf_data_len = data_len < max_data_len ? data_len : max_data_len;
 610
 611   int payload_offset = 0;
 612   for (i = 0; i < first_buf_data_len; i++)
 613     icmp46_echo->data[i] = get_icmp_echo_payload_byte (payload_offset++);
 614
 615   /* inspired by vlib_buffer_add_data */
 616   vlib_buffer_t *hb = b0;
 617   int remaining_data_len = data_len - first_buf_data_len;
 618   while (remaining_data_len)
 619     {
 620       int this_buf_data_len =
 621         remaining_data_len <
 622         vlib_buffer_get_default_data_size (vm) ? remaining_data_len :
 623         vlib_buffer_get_default_data_size (vm);
 624       int n_alloc = vlib_buffer_alloc (vm, &b0->next_buffer, 1);
 625       if (n_alloc < 1)
 626         {
 627           /* That is how much we have so far - return it... */
 628           return (data_len - remaining_data_len);
 629         }
 630       b0->flags |= VLIB_BUFFER_NEXT_PRESENT;
 631       /* move on to the newly acquired buffer */
 632       b0 = vlib_get_buffer (vm, b0->next_buffer);
 633       /* initialize the data */
 634       for (i = 0; i < this_buf_data_len; i++)
 635         {
 636           b0->data[i] = get_icmp_echo_payload_byte (payload_offset++);
 637         }
 638       b0->current_length = this_buf_data_len;
 639       b0->current_data = 0;
 640       remaining_data_len -= this_buf_data_len;
 641     }
 642   hb->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
 643   hb->current_length = l34_len + first_buf_data_len;
 644   hb->total_length_not_including_first_buffer = data_len - first_buf_data_len;
 645
 646   icmp46_echo->time_sent = now;
 647   icmp46_echo->seq = clib_host_to_net_u16 (seq_host);
 648   icmp46_echo->id = clib_host_to_net_u16 (id_host);
 649   return data_len;
 650 }
 651
 652
 653 static u32
 654 ip46_fib_index_from_table_id (u32 table_id, int is_ip6)
 655 {
 656   u32 fib_index = is_ip6 ?
 657     ip6_fib_index_from_table_id (table_id) :
 658     ip4_fib_index_from_table_id (table_id);
 659   return fib_index;
 660 }
 661
 662 static fib_node_index_t
 663 ip46_fib_table_lookup_host (u32 fib_index, ip46_address_t * pa46, int is_ip6)
 664 {
 665   fib_node_index_t fib_entry_index = is_ip6 ?
 666     ip6_fib_table_lookup (fib_index, &pa46->ip6, 128) :
 667     ip4_fib_table_lookup (ip4_fib_get (fib_index), &pa46->ip4, 32);
 668   return fib_entry_index;
 669 }
 670
 671 static u32
 672 ip46_get_resolving_interface (u32 fib_index, ip46_address_t * pa46,
 673                               int is_ip6)
 674 {
 675   u32 sw_if_index = ~0;
 676   if (~0 != fib_index)
 677     {
 678       fib_node_index_t fib_entry_index;
 679       fib_entry_index = ip46_fib_table_lookup_host (fib_index, pa46, is_ip6);
 680       sw_if_index = fib_entry_get_resolving_interface (fib_entry_index);
 681     }
 682   return sw_if_index;
 683 }
 684
 685 static u32
 686 ip46_fib_table_get_index_for_sw_if_index (u32 sw_if_index, int is_ip6,
 687                                           ip46_address_t *pa46)
 688 {
 689   if (is_ip6)
 690     {
 691       if (ip6_address_is_link_local_unicast (&pa46->ip6))
 692         return ip6_ll_fib_get (sw_if_index);
 693       return ip6_fib_table_get_index_for_sw_if_index (sw_if_index);
 694     }
 695   return ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
 696 }
 697
 698
 699 static int
 700 ip46_fill_l3_header (ip46_address_t * pa46, vlib_buffer_t * b0, int is_ip6)
 701 {
 702   if (is_ip6)
 703     {
 704       ip6_header_t *ip6 = vlib_buffer_get_current (b0);
 705       /* Fill in ip6 header fields */
 706       ip6->ip_version_traffic_class_and_flow_label =
 707         clib_host_to_net_u32 (0x6 << 28);
 708       ip6->payload_length = 0;  /* will be set later */
 709       ip6->protocol = IP_PROTOCOL_ICMP6;
 710       ip6->hop_limit = 255;
 711       ip6->dst_address = pa46->ip6;
 712       ip6->src_address = pa46->ip6;
 713       return (sizeof (ip6_header_t));
 714     }
 715   else
 716     {
 717       ip4_header_t *ip4 = vlib_buffer_get_current (b0);
 718       /* Fill in ip4 header fields */
 719       ip4->checksum = 0;
 720       ip4->ip_version_and_header_length = 0x45;
 721       ip4->tos = 0;
 722       ip4->length = 0;          /* will be set later */
 723       ip4->fragment_id = 0;
 724       ip4->flags_and_fragment_offset = 0;
 725       ip4->ttl = 0xff;
 726       ip4->protocol = IP_PROTOCOL_ICMP;
 727       ip4->src_address = pa46->ip4;
 728       ip4->dst_address = pa46->ip4;
 729       return (sizeof (ip4_header_t));
 730     }
 731 }
 732
 733 static bool
 734 ip46_set_src_address (u32 sw_if_index, vlib_buffer_t * b0, int is_ip6)
 735 {
 736   bool res = false;
 737
 738   if (is_ip6)
 739     {
 740       ip6_header_t *ip6 = vlib_buffer_get_current (b0);
 741
 742       res = ip6_sas_by_sw_if_index (sw_if_index, &ip6->dst_address,
 743                                     &ip6->src_address);
 744     }
 745   else
 746     {
 747       ip4_header_t *ip4 = vlib_buffer_get_current (b0);
 748
 749       res = ip4_sas_by_sw_if_index (sw_if_index, &ip4->dst_address,
 750                                     &ip4->src_address);
 751     }
 752   return res;
 753 }
 754
 755 static void
 756 ip46_print_buffer_src_address (vlib_main_t * vm, vlib_buffer_t * b0,
 757                                int is_ip6)
 758 {
 759   void *format_addr_func;
 760   void *paddr;
 761   if (is_ip6)
 762     {
 763       ip6_header_t *ip6 = vlib_buffer_get_current (b0);
 764       format_addr_func = format_ip6_address;
 765       paddr = &ip6->src_address;
 766     }
 767   else
 768     {
 769       ip4_header_t *ip4 = vlib_buffer_get_current (b0);
 770       format_addr_func = format_ip4_address;
 771       paddr = &ip4->src_address;
 772     }
 773   vlib_cli_output (vm, "Source address: %U ", format_addr_func, paddr);
 774 }
 775
 776 static u16
 777 ip46_fill_icmp_request_at (vlib_main_t * vm, int l4_offset, u16 seq_host,
 778                            u16 id_host, u16 data_len, vlib_buffer_t * b0,
 779                            int is_ip6)
 780 {
 781   icmp46_header_t *icmp46 = vlib_buffer_get_current (b0) + l4_offset;
 782
 783   icmp46->type = is_ip6 ? ICMP6_echo_request : ICMP4_echo_request;
 784   icmp46->code = 0;
 785   icmp46->checksum = 0;
 786
 787   icmp46_echo_request_t *icmp46_echo = (icmp46_echo_request_t *) (icmp46 + 1);
 788
 789   data_len =
 790     init_icmp46_echo_request (vm, b0, l4_offset, icmp46_echo, seq_host,
 791                               id_host, clib_cpu_time_now (), data_len);
 792   return data_len;
 793 }
 794
 795
 796 /* Compute ICMP4 checksum with multibuffer support. */
 797 u16
 798 ip4_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
 799                            ip4_header_t * ip0)
 800 {
 801   ip_csum_t sum0;
 802   u32 ip_header_length, payload_length_host_byte_order;
 803   u32 n_this_buffer, n_bytes_left, n_ip_bytes_this_buffer;
 804   u16 sum16;
 805   void *data_this_buffer;
 806
 807   ip_header_length = ip4_header_bytes (ip0);
 808   payload_length_host_byte_order =
 809     clib_net_to_host_u16 (ip0->length) - ip_header_length;
 810
 811   /* ICMP4 checksum does not include the IP header */
 812   sum0 = 0;
 813
 814   n_bytes_left = n_this_buffer = payload_length_host_byte_order;
 815   data_this_buffer = (void *) ip0 + ip_header_length;
 816   n_ip_bytes_this_buffer =
 817     p0->current_length - (((u8 *) ip0 - p0->data) - p0->current_data);
 818   if (n_this_buffer + ip_header_length > n_ip_bytes_this_buffer)
 819     {
 820       n_this_buffer = n_ip_bytes_this_buffer > ip_header_length ?
 821         n_ip_bytes_this_buffer - ip_header_length : 0;
 822     }
 823   while (1)
 824     {
 825       sum0 = ip_incremental_checksum (sum0, data_this_buffer, n_this_buffer);
 826       n_bytes_left -= n_this_buffer;
 827       if (n_bytes_left == 0)
 828         break;
 829
 830       ASSERT (p0->flags & VLIB_BUFFER_NEXT_PRESENT);
 831       p0 = vlib_get_buffer (vm, p0->next_buffer);
 832       data_this_buffer = vlib_buffer_get_current (p0);
 833       n_this_buffer = p0->current_length;
 834     }
 835
 836   sum16 = ~ip_csum_fold (sum0);
 837
 838   return sum16;
 839 }
 840
 841
 842 static void
 843 ip46_fix_len_and_csum (vlib_main_t * vm, int l4_offset, u16 data_len,
 844                        vlib_buffer_t * b0, int is_ip6)
 845 {
 846   u16 payload_length =
 847     data_len + sizeof (icmp46_header_t) + offsetof (icmp46_echo_request_t,
 848                                                     data);
 849   u16 total_length = payload_length + l4_offset;
 850   icmp46_header_t *icmp46 = vlib_buffer_get_current (b0) + l4_offset;
 851   icmp46->checksum = 0;
 852
 853   if (is_ip6)
 854     {
 855       ip6_header_t *ip6 = vlib_buffer_get_current (b0);
 856       ip6->payload_length = clib_host_to_net_u16 (payload_length);
 857
 858       int bogus_length = 0;
 859       icmp46->checksum =
 860         ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6, &bogus_length);
 861     }
 862   else
 863     {
 864       ip4_header_t *ip4 = vlib_buffer_get_current (b0);
 865       ip4->length = clib_host_to_net_u16 (total_length);
 866
 867       ip4->checksum = ip4_header_checksum (ip4);
 868       icmp46->checksum = ip4_icmp_compute_checksum (vm, b0, ip4);
 869     }
 870 }
 871
 872 static u16
 873 at_most_a_frame (u32 count)
 874 {
 875   return count > VLIB_FRAME_SIZE ? VLIB_FRAME_SIZE : count;
 876 }
 877
 878 static int
 879 ip46_enqueue_packet (vlib_main_t *vm, vlib_buffer_t *b0, u32 burst,
 880                      u32 lookup_node_index)
 881 {
 882   vlib_frame_t *f = 0;
 883   int n_sent = 0;
 884
 885   u16 n_to_send;
 886
 887   /*
 888    * Enqueue the packet, possibly as one or more frames of copies to make
 889    * bursts. We enqueue b0 as the very last buffer, when there is no possibility
 890    * for error in vlib_buffer_copy, so as to allow the caller to free it
 891    * in case we encounter the error in the middle of the loop.
 892    */
 893   for (n_to_send = at_most_a_frame (burst), burst -= n_to_send; n_to_send > 0;
 894        n_to_send = at_most_a_frame (burst), burst -= n_to_send)
 895     {
 896       f = vlib_get_frame_to_node (vm, lookup_node_index);
 897       /* f can not be NULL here - frame allocation failure causes panic */
 898
 899       u32 *to_next = vlib_frame_vector_args (f);
 900       f->n_vectors = n_to_send;
 901
 902       while (n_to_send > 1)
 903         {
 904           vlib_buffer_t *b0copy = vlib_buffer_copy (vm, b0);
 905           if (PREDICT_FALSE (b0copy == NULL))
 906             goto ship_and_ret;
 907           *to_next++ = vlib_get_buffer_index (vm, b0copy);
 908           n_to_send--;
 909           n_sent++;
 910         }
 911
 912       /* n_to_send is guaranteed to equal 1 here */
 913       if (burst > 0)
 914         {
 915           /* not the last burst, so still make a copy for the last buffer */
 916           vlib_buffer_t *b0copy = vlib_buffer_copy (vm, b0);
 917           if (PREDICT_FALSE (b0copy == NULL))
 918             goto ship_and_ret;
 919           n_to_send--;
 920           *to_next++ = vlib_get_buffer_index (vm, b0copy);
 921         }
 922       else
 923         {
 924           /* put the original buffer as the last one of an error-free run */
 925           *to_next++ = vlib_get_buffer_index (vm, b0);
 926         }
 927       vlib_put_frame_to_node (vm, lookup_node_index, f);
 928       n_sent += f->n_vectors;
 929     }
 930   return n_sent;
 931   /*
 932    * We reach here in case we already enqueued one or more buffers
 933    * and maybe one or more frames but could not make more copies.
 934    * There is an outstanding frame - so ship it and return.
 935    * Caller will have to free the b0 in this case, since
 936    * we did not enqueue it here yet.
 937    */
 938 ship_and_ret:
 939   ASSERT (n_to_send <= f->n_vectors);
 940   f->n_vectors -= n_to_send;
 941   n_sent += f->n_vectors;
 942   vlib_put_frame_to_node (vm, lookup_node_index, f);
 943   return n_sent;
 944 }
 945
 946
 947 /*
 948  * An address-family agnostic ping send function.
 949  */
 950
 951 #define ERROR_OUT(e) do { err = e; goto done; } while (0)
 952
 953 static send_ip46_ping_result_t
 954 send_ip46_ping (vlib_main_t * vm,
 955                 u32 table_id,
 956                 ip46_address_t * pa46,
 957                 u32 sw_if_index,
 958                 u16 seq_host, u16 id_host, u16 data_len, u32 burst,
 959                 u8 verbose, int is_ip6)
 960 {
 961   int err = SEND_PING_OK;
 962   u32 bi0 = 0;
 963   int n_buf0 = 0;
 964   vlib_buffer_t *b0;
 965
 966   n_buf0 = vlib_buffer_alloc (vm, &bi0, 1);
 967   if (n_buf0 < 1)
 968     ERROR_OUT (SEND_PING_ALLOC_FAIL);
 969
 970   b0 = vlib_get_buffer (vm, bi0);
 971
 972   /*
 973    * if the user did not provide a source interface,
 974    * perform a resolution and use an interface
 975    * via which it succeeds.
 976    */
 977   u32 fib_index;
 978   if (~0 == sw_if_index)
 979     {
 980       fib_index = ip46_fib_index_from_table_id (table_id, is_ip6);
 981       sw_if_index = ip46_get_resolving_interface (fib_index, pa46, is_ip6);
 982     }
 983   else
 984     fib_index =
 985       ip46_fib_table_get_index_for_sw_if_index (sw_if_index, is_ip6, pa46);
 986
 987   if (~0 == fib_index)
 988     ERROR_OUT (SEND_PING_NO_TABLE);
 989   if (~0 == sw_if_index)
 990     ERROR_OUT (SEND_PING_NO_INTERFACE);
 991
 992   vnet_buffer (b0)->sw_if_index[VLIB_RX] = sw_if_index;
 993
 994   int l4_header_offset = ip46_fill_l3_header (pa46, b0, is_ip6);
 995
 996   /* set the src address in the buffer */
 997   if (!ip46_set_src_address (sw_if_index, b0, is_ip6))
 998     ERROR_OUT (SEND_PING_NO_SRC_ADDRESS);
 999   if (verbose)
1000     ip46_print_buffer_src_address (vm, b0, is_ip6);
1001
1002   data_len =
1003     ip46_fill_icmp_request_at (vm, l4_header_offset, seq_host, id_host,
1004                                data_len, b0, is_ip6);
1005
1006   ip46_fix_len_and_csum (vm, l4_header_offset, data_len, b0, is_ip6);
1007
1008   u32 node_index = ip6_lookup_node.index;
1009   if (is_ip6)
1010     {
1011       if (pa46->ip6.as_u32[0] == clib_host_to_net_u32 (0xff020000))
1012         {
1013           node_index = ip6_rewrite_mcast_node.index;
1014           vnet_buffer (b0)->sw_if_index[VLIB_RX] = sw_if_index;
1015           vnet_buffer (b0)->sw_if_index[VLIB_TX] = sw_if_index;
1016           vnet_buffer (b0)->ip.adj_index[VLIB_TX] =
1017             ip6_link_get_mcast_adj (sw_if_index);
1018         }
1019     }
1020   else
1021     {
1022       node_index = ip4_lookup_node.index;
1023     }
1024   int n_sent = ip46_enqueue_packet (vm, b0, burst, node_index);
1025   if (n_sent < burst)
1026     err = SEND_PING_NO_BUFFERS;
1027
1028 done:
1029   if (err != SEND_PING_OK)
1030     {
1031       if (n_buf0 > 0)
1032         vlib_buffer_free (vm, &bi0, 1);
1033     }
1034   return err;
1035 }
1036
1037 static send_ip46_ping_result_t
1038 send_ip6_ping (vlib_main_t * vm,
1039                u32 table_id, ip6_address_t * pa6,
1040                u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len,
1041                u32 burst, u8 verbose)
1042 {
1043   ip46_address_t target;
1044   target.ip6 = *pa6;
1045   return send_ip46_ping (vm, table_id, &target, sw_if_index, seq_host,
1046                          id_host, data_len, burst, verbose, 1 /* is_ip6 */ );
1047 }
1048
1049 static send_ip46_ping_result_t
1050 send_ip4_ping (vlib_main_t * vm,
1051                u32 table_id, ip4_address_t * pa4,
1052                u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len,
1053                u32 burst, u8 verbose)
1054 {
1055   ip46_address_t target;
1056   ip46_address_set_ip4 (&target, pa4);
1057   return send_ip46_ping (vm, table_id, &target, sw_if_index, seq_host,
1058                          id_host, data_len, burst, verbose, 0 /* is_ip6 */ );
1059 }
1060
1061 static void
1062 print_ip46_icmp_reply (vlib_main_t * vm, u32 bi0, int is_ip6)
1063 {
1064   vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
1065   int l4_offset;
1066   void *paddr;
1067   void *format_addr_func;
1068   u16 payload_length;
1069   u8 ttl;
1070   if (is_ip6)
1071     {
1072       ip6_header_t *ip6 = vlib_buffer_get_current (b0);
1073       paddr = (void *) &ip6->src_address;
1074       format_addr_func = (void *) format_ip6_address;
1075       ttl = ip6->hop_limit;
1076       l4_offset = sizeof (ip6_header_t);        // FIXME - EH processing ?
1077       payload_length = clib_net_to_host_u16 (ip6->payload_length);
1078     }
1079   else
1080     {
1081       ip4_header_t *ip4 = vlib_buffer_get_current (b0);
1082       paddr = (void *) &ip4->src_address;
1083       format_addr_func = (void *) format_ip4_address;
1084       ttl = ip4->ttl;
1085       l4_offset = ip4_header_bytes (ip4);
1086       payload_length =
1087         clib_net_to_host_u16 (ip4->length) + ip4_header_bytes (ip4);
1088     }
1089   icmp46_header_t *icmp = vlib_buffer_get_current (b0) + l4_offset;
1090   icmp46_echo_request_t *icmp_echo = (icmp46_echo_request_t *) (icmp + 1);
1091   u64 *dataplane_ts = (u64 *) & vnet_buffer (b0)->unused[0];
1092
1093   f64 clocks_per_second = ((f64) vm->clib_time.clocks_per_second);
1094   f64 rtt =
1095     ((f64) (*dataplane_ts - icmp_echo->time_sent)) / clocks_per_second;
1096
1097   vlib_cli_output (vm,
1098                    "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
1099                    payload_length,
1100                    format_addr_func,
1101                    paddr,
1102                    clib_host_to_net_u16 (icmp_echo->seq), ttl, rtt * 1000.0);
1103 }
1104
1105 /*
1106  * Perform the ping run with the given parameters in the current CLI process.
1107  * Depending on whether pa4 or pa6 is set, runs IPv4 or IPv6 ping.
1108  * The amusing side effect is of course if both are set, then both pings are sent.
1109  * This behavior can be used to ping a dualstack host over IPv4 and IPv6 at once.
1110  */
1111
1112 static void
1113 run_ping_ip46_address (vlib_main_t * vm, u32 table_id, ip4_address_t * pa4,
1114                        ip6_address_t * pa6, u32 sw_if_index,
1115                        f64 ping_interval, u32 ping_repeat, u32 data_len,
1116                        u32 ping_burst, u32 verbose)
1117 {
1118   int i;
1119   uword curr_proc = vlib_current_process (vm);
1120   u32 n_replies = 0;
1121   u32 n_requests = 0;
1122   u16 icmp_id;
1123
1124   static u32 rand_seed = 0;
1125
1126   if (PREDICT_FALSE (!rand_seed))
1127     rand_seed = random_default_seed ();
1128
1129   icmp_id = random_u32 (&rand_seed) & 0xffff;
1130
1131   while (~0 != get_cli_process_id_by_icmp_id_mt (vm, icmp_id))
1132     {
1133       vlib_cli_output (vm, "ICMP ID collision at %d, incrementing", icmp_id);
1134       icmp_id++;
1135     }
1136
1137   set_cli_process_id_by_icmp_id_mt (vm, icmp_id, curr_proc);
1138
1139   for (i = 1; i <= ping_repeat; i++)
1140     {
1141       send_ip46_ping_result_t res = SEND_PING_OK;
1142       f64 sleep_interval;
1143       f64 time_ping_sent = vlib_time_now (vm);
1144       if (pa6)
1145         {
1146           res = send_ip6_ping (vm, table_id,
1147                                pa6, sw_if_index, i, icmp_id,
1148                                data_len, ping_burst, verbose);
1149           if (SEND_PING_OK == res)
1150             n_requests += ping_burst;
1151           else
1152             vlib_cli_output (vm, "Failed: %U", format_ip46_ping_result, res);
1153         }
1154       if (pa4)
1155         {
1156           res = send_ip4_ping (vm, table_id, pa4,
1157                                sw_if_index, i, icmp_id, data_len,
1158                                ping_burst, verbose);
1159           if (SEND_PING_OK == res)
1160             n_requests += ping_burst;
1161           else
1162             vlib_cli_output (vm, "Failed: %U", format_ip46_ping_result, res);
1163         }
1164
1165       /* Collect and print the responses until it is time to send a next ping */
1166
1167       while ((i <= ping_repeat)
1168              &&
1169              ((sleep_interval =
1170                time_ping_sent + ping_interval - vlib_time_now (vm)) > 0.0))
1171         {
1172           uword event_type, *event_data = 0;
1173           vlib_process_wait_for_event_or_clock (vm, sleep_interval);
1174           event_type = vlib_process_get_events (vm, &event_data);
1175           switch (event_type)
1176             {
1177             case ~0:            /* no events => timeout */
1178               break;
1179             case PING_RESPONSE_IP6:
1180               /* fall-through */
1181             case PING_RESPONSE_IP4:
1182               {
1183                 int ii;
1184                 int is_ip6 = (event_type == PING_RESPONSE_IP6);
1185                 for (ii = 0; ii < vec_len (event_data); ii++)
1186                   {
1187                     u32 bi0 = event_data[ii];
1188                     print_ip46_icmp_reply (vm, bi0, is_ip6);
1189                     n_replies++;
1190                     if (0 != bi0)
1191                       vlib_buffer_free (vm, &bi0, 1);
1192                   }
1193               }
1194               break;
1195             case UNIX_CLI_PROCESS_EVENT_READ_READY:
1196             case UNIX_CLI_PROCESS_EVENT_QUIT:
1197               /* someone pressed a key, abort */
1198               vlib_cli_output (vm, "Aborted due to a keypress.");
1199               goto double_break;
1200             }
1201           vec_free (event_data);
1202         }
1203     }
1204 double_break:
1205   vlib_cli_output (vm, "\n");
1206   {
1207     float loss =
1208       (0 ==
1209        n_requests) ? 0 : 100.0 * ((float) n_requests -
1210                                   (float) n_replies) / (float) n_requests;
1211     vlib_cli_output (vm,
1212                      "Statistics: %u sent, %u received, %f%% packet loss\n",
1213                      n_requests, n_replies, loss);
1214     clear_cli_process_id_by_icmp_id_mt (vm, icmp_id);
1215   }
1216 }
1217
1218
1219
1220 static clib_error_t *
1221 ping_ip_address (vlib_main_t * vm,
1222                  unformat_input_t * input, vlib_cli_command_t * cmd)
1223 {
1224   ip4_address_t a4;
1225   ip6_address_t a6;
1226   clib_error_t *error = 0;
1227   u32 ping_repeat = 5;
1228   u32 ping_burst = 1;
1229   u8 ping_ip4, ping_ip6;
1230   vnet_main_t *vnm = vnet_get_main ();
1231   u32 data_len = PING_DEFAULT_DATA_LEN;
1232   u32 verbose = 0;
1233   f64 ping_interval = PING_DEFAULT_INTERVAL;
1234   u32 sw_if_index, table_id;
1235
1236   table_id = 0;
1237   ping_ip4 = ping_ip6 = 0;
1238   sw_if_index = ~0;
1239
1240   if (unformat (input, "%U", unformat_ip4_address, &a4))
1241     {
1242       ping_ip4 = 1;
1243     }
1244   else if (unformat (input, "%U", unformat_ip6_address, &a6))
1245     {
1246       ping_ip6 = 1;
1247     }
1248   else if (unformat (input, "ipv4"))
1249     {
1250       if (unformat (input, "%U", unformat_ip4_address, &a4))
1251         {
1252           ping_ip4 = 1;
1253         }
1254       else
1255         {
1256           error =
1257             clib_error_return (0,
1258                                "expecting IPv4 address but got `%U'",
1259                                format_unformat_error, input);
1260         }
1261     }
1262   else if (unformat (input, "ipv6"))
1263     {
1264       if (unformat (input, "%U", unformat_ip6_address, &a6))
1265         {
1266           ping_ip6 = 1;
1267         }
1268       else
1269         {
1270           error =
1271             clib_error_return (0,
1272                                "expecting IPv6 address but got `%U'",
1273                                format_unformat_error, input);
1274         }
1275     }
1276   else
1277     {
1278       error =
1279         clib_error_return (0,
1280                            "expecting IP4/IP6 address `%U'. Usage: ping <addr> [source <intf>] [size <datasz>] [repeat <count>] [verbose]",
1281                            format_unformat_error, input);
1282       goto done;
1283     }
1284
1285   /* allow for the second AF in the same ping */
1286   if (!ping_ip4 && (unformat (input, "ipv4")))
1287     {
1288       if (unformat (input, "%U", unformat_ip4_address, &a4))
1289         {
1290           ping_ip4 = 1;
1291         }
1292     }
1293   else if (!ping_ip6 && (unformat (input, "ipv6")))
1294     {
1295       if (unformat (input, "%U", unformat_ip6_address, &a6))
1296         {
1297           ping_ip6 = 1;
1298         }
1299     }
1300
1301   /* parse the rest of the parameters  in a cycle */
1302   while (!unformat_eof (input, NULL))
1303     {
1304       if (unformat (input, "source"))
1305         {
1306           if (!unformat_user
1307               (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1308             {
1309               error =
1310                 clib_error_return (0,
1311                                    "unknown interface `%U'",
1312                                    format_unformat_error, input);
1313               goto done;
1314             }
1315         }
1316       else if (unformat (input, "size"))
1317         {
1318           if (!unformat (input, "%u", &data_len))
1319             {
1320               error =
1321                 clib_error_return (0,
1322                                    "expecting size but got `%U'",
1323                                    format_unformat_error, input);
1324               goto done;
1325             }
1326           if (data_len > PING_MAXIMUM_DATA_SIZE)
1327             {
1328               error =
1329                 clib_error_return (0,
1330                                    "%d is bigger than maximum allowed payload size %d",
1331                                    data_len, PING_MAXIMUM_DATA_SIZE);
1332               goto done;
1333             }
1334         }
1335       else if (unformat (input, "table-id"))
1336         {
1337           if (!unformat (input, "%u", &table_id))
1338             {
1339               error =
1340                 clib_error_return (0,
1341                                    "expecting table-id but got `%U'",
1342                                    format_unformat_error, input);
1343               goto done;
1344             }
1345         }
1346       else if (unformat (input, "interval"))
1347         {
1348           if (!unformat (input, "%f", &ping_interval))
1349             {
1350               error =
1351                 clib_error_return (0,
1352                                    "expecting interval (floating point number) got `%U'",
1353                                    format_unformat_error, input);
1354               goto done;
1355             }
1356         }
1357       else if (unformat (input, "repeat"))
1358         {
1359           if (!unformat (input, "%u", &ping_repeat))
1360             {
1361               error =
1362                 clib_error_return (0,
1363                                    "expecting repeat count but got `%U'",
1364                                    format_unformat_error, input);
1365               goto done;
1366             }
1367         }
1368       else if (unformat (input, "burst"))
1369         {
1370           if (!unformat (input, "%u", &ping_burst))
1371             {
1372               error =
1373                 clib_error_return (0,
1374                                    "expecting burst count but got `%U'",
1375                                    format_unformat_error, input);
1376               goto done;
1377             }
1378         }
1379       else if (unformat (input, "verbose"))
1380         {
1381           verbose = 1;
1382         }
1383       else
1384         {
1385           error = clib_error_return (0, "unknown input `%U'",
1386                                      format_unformat_error, input);
1387           goto done;
1388         }
1389     }
1390
1391 /*
1392  * Operationally, one won't (and shouldn't) need to send more than a frame worth of pings.
1393  * But it may be handy during the debugging.
1394  */
1395
1396 #ifdef CLIB_DEBUG
1397 #define MAX_PING_BURST (10*VLIB_FRAME_SIZE)
1398 #else
1399 #define MAX_PING_BURST (VLIB_FRAME_SIZE)
1400 #endif
1401
1402   if (ping_burst < 1 || ping_burst > MAX_PING_BURST)
1403     return clib_error_return (0, "burst size must be between 1 and %u",
1404                               MAX_PING_BURST);
1405
1406   run_ping_ip46_address (vm, table_id, ping_ip4 ? &a4 : NULL,
1407                          ping_ip6 ? &a6 : NULL, sw_if_index, ping_interval,
1408                          ping_repeat, data_len, ping_burst, verbose);
1409 done:
1410   return error;
1411 }
1412
1413 /*?
1414  * This command sends an ICMP ECHO_REQUEST to network hosts. The address
1415  * can be an IPv4 or IPv6 address (or both at the same time).
1416  *
1417  * @cliexpar
1418  * @parblock
1419  * Example of how ping an IPv4 address:
1420  * @cliexstart{ping 172.16.1.2 source GigabitEthernet2/0/0 repeat 2}
1421  * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1090 ms
1422  * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0914 ms
1423  *
1424  * Statistics: 2 sent, 2 received, 0% packet loss
1425  * @cliexend
1426  *
1427  * Example of how ping both an IPv4 address and IPv6 address at the same time:
1428  * @cliexstart{ping 172.16.1.2 ipv6 fe80::24a5:f6ff:fe9c:3a36 source GigabitEthernet2/0/0 repeat 2 verbose}
1429  * Adjacency index: 10, sw_if_index: 1
1430  * Adj: ip6-discover-neighbor
1431  * Adj Interface: 0
1432  * Forced set interface: 1
1433  * Adjacency index: 0, sw_if_index: 4294967295
1434  * Adj: ip4-miss
1435  * Adj Interface: 0
1436  * Forced set interface: 1
1437  * Source address: 172.16.1.1
1438  * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1899 ms
1439  * Adjacency index: 10, sw_if_index: 1
1440  * Adj: ip6-discover-neighbor
1441  * Adj Interface: 0
1442  * Forced set interface: 1
1443  * Adjacency index: 0, sw_if_index: 4294967295
1444  * Adj: ip4-miss
1445  * Adj Interface: 0
1446  * Forced set interface: 1
1447  * Source address: 172.16.1.1
1448  * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0910 ms
1449  *
1450  * Statistics: 4 sent, 2 received, 50% packet loss
1451  * @cliexend
1452  * @endparblock
1453 ?*/
1454 /* *INDENT-OFF* */
1455 VLIB_CLI_COMMAND (ping_command, static) =
1456 {
1457   .path = "ping",
1458   .function = ping_ip_address,
1459   .short_help = "ping {<ip-addr> | ipv4 <ip4-addr> | ipv6 <ip6-addr>}"
1460   " [ipv4 <ip4-addr> | ipv6 <ip6-addr>] [source <interface>]"
1461   " [size <pktsize:60>] [interval <sec:1>] [repeat <cnt:5>] [table-id <id:0>]"
1462   " [burst <count:1>] [verbose]",
1463   .is_mp_safe = 1,
1464 };
1465 /* *INDENT-ON* */
1466
1467 static clib_error_t *
1468 ping_cli_init (vlib_main_t * vm)
1469 {
1470   vlib_thread_main_t *tm = vlib_get_thread_main ();
1471   ping_main_t *pm = &ping_main;
1472
1473   pm->ip6_main = &ip6_main;
1474   pm->ip4_main = &ip4_main;
1475   icmp6_register_type (vm, ICMP6_echo_reply, ip6_icmp_echo_reply_node.index);
1476   ip4_icmp_register_type (vm, ICMP4_echo_reply,
1477                           ip4_icmp_echo_reply_node.index);
1478   if (tm->n_vlib_mains > 1)
1479     clib_spinlock_init (&pm->ping_run_check_lock);
1480
1481   ip4_icmp_register_type (vm, ICMP4_echo_request,
1482                           ip4_icmp_echo_request_node.index);
1483
1484   return 0;
1485 }
1486
1487 VLIB_INIT_FUNCTION (ping_cli_init);
1488
1489 /* *INDENT-OFF* */
1490 VLIB_PLUGIN_REGISTER () = {
1491     .version = VPP_BUILD_VER,
1492     .description = "Ping (ping)",
1493 };
1494 /* *INDENT-ON* */
1495
1496 /*
1497  * fd.io coding-style-patch-verification: ON
1498  *
1499  * Local Variables:
1500  * eval: (c-set-style "gnu")
1501  * End:
1502  */