src/vnet/ip/lookup.c

   1 /*
   2  * Copyright (c) 2015 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  * ip/ip_lookup.c: ip4/6 adjacency and lookup table managment
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #include <vnet/ip/ip.h>
  41 #include <vnet/adj/adj.h>
  42 #include <vnet/fib/fib_table.h>
  43 #include <vnet/fib/ip4_fib.h>
  44 #include <vnet/fib/ip6_fib.h>
  45 #include <vnet/mpls/mpls.h>
  46 #include <vnet/mfib/mfib_table.h>
  47 #include <vnet/dpo/drop_dpo.h>
  48 #include <vnet/dpo/classify_dpo.h>
  49 #include <vnet/dpo/punt_dpo.h>
  50 #include <vnet/dpo/receive_dpo.h>
  51 #include <vnet/dpo/ip_null_dpo.h>
  52 #include <vnet/ip/ip6_neighbor.h>
  53
  54 /**
  55  * @file
  56  * @brief IPv4 and IPv6 adjacency and lookup table managment.
  57  *
  58  */
  59
  60 clib_error_t *
  61 ip_interface_address_add_del (ip_lookup_main_t * lm,
  62                               u32 sw_if_index,
  63                               void *addr_fib,
  64                               u32 address_length,
  65                               u32 is_del, u32 * result_if_address_index)
  66 {
  67   vnet_main_t *vnm = vnet_get_main ();
  68   ip_interface_address_t *a, *prev, *next;
  69   uword *p = mhash_get (&lm->address_to_if_address_index, addr_fib);
  70
  71   vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index,
  72                            sw_if_index, ~0);
  73   a = p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
  74
  75   /* Verify given length. */
  76   if ((a && (address_length != a->address_length)) ||
  77       (address_length == 0) ||
  78       (lm->is_ip6 && address_length > 128) ||
  79       (!lm->is_ip6 && address_length > 32))
  80     {
  81       vnm->api_errno = VNET_API_ERROR_ADDRESS_LENGTH_MISMATCH;
  82       return clib_error_create
  83         ("%U wrong length (expected %d) for interface %U",
  84          lm->format_address_and_length, addr_fib,
  85          address_length, a ? a->address_length : -1,
  86          format_vnet_sw_if_index_name, vnm, sw_if_index);
  87     }
  88
  89   if (is_del)
  90     {
  91       if (!a)
  92         {
  93           vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
  94           vnm->api_errno = VNET_API_ERROR_ADDRESS_NOT_FOUND_FOR_INTERFACE;
  95           return clib_error_create ("%U not found for interface %U",
  96                                     lm->format_address_and_length,
  97                                     addr_fib, address_length,
  98                                     format_vnet_sw_interface_name, vnm, si);
  99         }
 100
 101       if (a->prev_this_sw_interface != ~0)
 102         {
 103           prev =
 104             pool_elt_at_index (lm->if_address_pool,
 105                                a->prev_this_sw_interface);
 106           prev->next_this_sw_interface = a->next_this_sw_interface;
 107         }
 108       if (a->next_this_sw_interface != ~0)
 109         {
 110           next =
 111             pool_elt_at_index (lm->if_address_pool,
 112                                a->next_this_sw_interface);
 113           next->prev_this_sw_interface = a->prev_this_sw_interface;
 114
 115           if (a->prev_this_sw_interface == ~0)
 116             lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
 117               a->next_this_sw_interface;
 118         }
 119
 120       if ((a->next_this_sw_interface == ~0)
 121           && (a->prev_this_sw_interface == ~0))
 122         lm->if_address_pool_index_by_sw_if_index[sw_if_index] = ~0;
 123
 124       mhash_unset (&lm->address_to_if_address_index, addr_fib,
 125                    /* old_value */ 0);
 126       pool_put (lm->if_address_pool, a);
 127
 128       if (result_if_address_index)
 129         *result_if_address_index = ~0;
 130     }
 131
 132   else if (!a)
 133     {
 134       u32 pi;                   /* previous index */
 135       u32 ai;
 136       u32 hi;                   /* head index */
 137
 138       pool_get (lm->if_address_pool, a);
 139       memset (a, ~0, sizeof (a[0]));
 140       ai = a - lm->if_address_pool;
 141
 142       hi = pi = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
 143       prev = 0;
 144       while (pi != (u32) ~ 0)
 145         {
 146           prev = pool_elt_at_index (lm->if_address_pool, pi);
 147           pi = prev->next_this_sw_interface;
 148         }
 149       pi = prev ? prev - lm->if_address_pool : (u32) ~ 0;
 150
 151       a->address_key = mhash_set (&lm->address_to_if_address_index,
 152                                   addr_fib, ai, /* old_value */ 0);
 153       a->address_length = address_length;
 154       a->sw_if_index = sw_if_index;
 155       a->flags = 0;
 156       a->prev_this_sw_interface = pi;
 157       a->next_this_sw_interface = ~0;
 158       if (prev)
 159         prev->next_this_sw_interface = ai;
 160
 161       lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
 162         (hi != ~0) ? hi : ai;
 163       if (result_if_address_index)
 164         *result_if_address_index = ai;
 165     }
 166   else
 167     {
 168       if (result_if_address_index)
 169         *result_if_address_index = a - lm->if_address_pool;
 170     }
 171
 172
 173   return /* no error */ 0;
 174 }
 175
 176 static clib_error_t *
 177 ip_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
 178 {
 179   vec_validate_init_empty (ip4_main.
 180                            lookup_main.if_address_pool_index_by_sw_if_index,
 181                            sw_if_index, ~0);
 182   vec_validate_init_empty (ip6_main.
 183                            lookup_main.if_address_pool_index_by_sw_if_index,
 184                            sw_if_index, ~0);
 185
 186   return (NULL);
 187 }
 188
 189 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip_sw_interface_add_del);
 190
 191 void
 192 ip_lookup_init (ip_lookup_main_t * lm, u32 is_ip6)
 193 {
 194   if (!lm->fib_result_n_bytes)
 195     lm->fib_result_n_bytes = sizeof (uword);
 196
 197   lm->is_ip6 = is_ip6;
 198   if (is_ip6)
 199     {
 200       lm->format_address_and_length = format_ip6_address_and_length;
 201       mhash_init (&lm->address_to_if_address_index, sizeof (uword),
 202                   sizeof (ip6_address_fib_t));
 203     }
 204   else
 205     {
 206       lm->format_address_and_length = format_ip4_address_and_length;
 207       mhash_init (&lm->address_to_if_address_index, sizeof (uword),
 208                   sizeof (ip4_address_fib_t));
 209     }
 210
 211   {
 212     int i;
 213
 214     /* Setup all IP protocols to be punted and builtin-unknown. */
 215     for (i = 0; i < 256; i++)
 216       {
 217         lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
 218         lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
 219       }
 220
 221     lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
 222     lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
 223                                   IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
 224     lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] =
 225       IP_BUILTIN_PROTOCOL_UDP;
 226     lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
 227                                         IP_PROTOCOL_ICMP] =
 228       IP_BUILTIN_PROTOCOL_ICMP;
 229   }
 230 }
 231
 232 u8 *
 233 format_ip_flow_hash_config (u8 * s, va_list * args)
 234 {
 235   flow_hash_config_t flow_hash_config = va_arg (*args, u32);
 236
 237 #define _(n,v) if (flow_hash_config & v) s = format (s, "%s ", #n);
 238   foreach_flow_hash_bit;
 239 #undef _
 240
 241   return s;
 242 }
 243
 244 u8 *
 245 format_ip_lookup_next (u8 * s, va_list * args)
 246 {
 247   /* int promotion of ip_lookup_next_t */
 248   ip_lookup_next_t n = va_arg (*args, int);
 249   char *t = 0;
 250
 251   switch (n)
 252     {
 253     default:
 254       s = format (s, "unknown %d", n);
 255       return s;
 256
 257     case IP_LOOKUP_NEXT_DROP:
 258       t = "drop";
 259       break;
 260     case IP_LOOKUP_NEXT_PUNT:
 261       t = "punt";
 262       break;
 263     case IP_LOOKUP_NEXT_ARP:
 264       t = "arp";
 265       break;
 266     case IP_LOOKUP_NEXT_MIDCHAIN:
 267       t = "midchain";
 268       break;
 269     case IP_LOOKUP_NEXT_GLEAN:
 270       t = "glean";
 271       break;
 272     case IP_LOOKUP_NEXT_MCAST:
 273       t = "mcast";
 274       break;
 275     case IP_LOOKUP_NEXT_REWRITE:
 276       break;
 277     }
 278
 279   if (t)
 280     vec_add (s, t, strlen (t));
 281
 282   return s;
 283 }
 284
 285 u8 *
 286 format_ip_adjacency_packet_data (u8 * s, va_list * args)
 287 {
 288   u32 adj_index = va_arg (*args, u32);
 289   u8 *packet_data = va_arg (*args, u8 *);
 290   u32 n_packet_data_bytes = va_arg (*args, u32);
 291   ip_adjacency_t *adj = adj_get (adj_index);
 292
 293   switch (adj->lookup_next_index)
 294     {
 295     case IP_LOOKUP_NEXT_REWRITE:
 296     case IP_LOOKUP_NEXT_MCAST:
 297       s =
 298         format (s, "%U", format_hex_bytes, packet_data, n_packet_data_bytes);
 299       break;
 300
 301     default:
 302       break;
 303     }
 304
 305   return s;
 306 }
 307
 308 static uword
 309 unformat_dpo (unformat_input_t * input, va_list * args)
 310 {
 311   dpo_id_t *dpo = va_arg (*args, dpo_id_t *);
 312   fib_protocol_t fp = va_arg (*args, int);
 313   dpo_proto_t proto;
 314
 315   proto = fib_proto_to_dpo (fp);
 316
 317   if (unformat (input, "drop"))
 318     dpo_copy (dpo, drop_dpo_get (proto));
 319   else if (unformat (input, "punt"))
 320     dpo_copy (dpo, punt_dpo_get (proto));
 321   else if (unformat (input, "local"))
 322     receive_dpo_add_or_lock (proto, ~0, NULL, dpo);
 323   else if (unformat (input, "null-send-unreach"))
 324     ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_UNREACH, dpo);
 325   else if (unformat (input, "null-send-prohibit"))
 326     ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_PROHIBIT, dpo);
 327   else if (unformat (input, "null"))
 328     ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_NONE, dpo);
 329   else if (unformat (input, "classify"))
 330     {
 331       u32 classify_table_index;
 332
 333       if (!unformat (input, "%d", &classify_table_index))
 334         {
 335           clib_warning ("classify adj must specify table index");
 336           return 0;
 337         }
 338
 339       dpo_set (dpo, DPO_CLASSIFY, proto,
 340                classify_dpo_create (proto, classify_table_index));
 341     }
 342   else
 343     return 0;
 344
 345   return 1;
 346 }
 347
 348 const ip46_address_t zero_addr = {
 349   .as_u64 = {
 350              0, 0},
 351 };
 352
 353 clib_error_t *
 354 vnet_ip_route_cmd (vlib_main_t * vm,
 355                    unformat_input_t * main_input, vlib_cli_command_t * cmd)
 356 {
 357   unformat_input_t _line_input, *line_input = &_line_input;
 358   fib_route_path_t *rpaths = NULL, rpath;
 359   dpo_id_t dpo = DPO_INVALID, *dpos = NULL;
 360   fib_prefix_t *prefixs = NULL, pfx;
 361   mpls_label_t out_label, via_label;
 362   clib_error_t *error = NULL;
 363   u32 weight, preference;
 364   u32 table_id, is_del;
 365   vnet_main_t *vnm;
 366   u32 fib_index;
 367   f64 count;
 368   int i;
 369
 370   vnm = vnet_get_main ();
 371   is_del = 0;
 372   table_id = 0;
 373   count = 1;
 374   memset (&pfx, 0, sizeof (pfx));
 375   out_label = via_label = MPLS_LABEL_INVALID;
 376
 377   /* Get a line of input. */
 378   if (!unformat_user (main_input, unformat_line_input, line_input))
 379     return 0;
 380
 381   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 382     {
 383       memset (&rpath, 0, sizeof (rpath));
 384
 385       if (unformat (line_input, "table %d", &table_id))
 386         ;
 387       else if (unformat (line_input, "resolve-via-host"))
 388         {
 389           if (vec_len (rpaths) == 0)
 390             {
 391               error = clib_error_return (0, "Paths then flags");
 392               goto done;
 393             }
 394           rpaths[vec_len (rpaths) - 1].frp_flags |=
 395             FIB_ROUTE_PATH_RESOLVE_VIA_HOST;
 396         }
 397       else if (unformat (line_input, "resolve-via-attached"))
 398         {
 399           if (vec_len (rpaths) == 0)
 400             {
 401               error = clib_error_return (0, "Paths then flags");
 402               goto done;
 403             }
 404           rpaths[vec_len (rpaths) - 1].frp_flags |=
 405             FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED;
 406         }
 407       else if (unformat (line_input, "out-labels"))
 408         {
 409           if (vec_len (rpaths) == 0)
 410             {
 411               error = clib_error_return (0, "Paths then labels");
 412               goto done;
 413             }
 414           else
 415             {
 416               while (unformat (line_input, "%U",
 417                                unformat_mpls_unicast_label, &out_label))
 418                 {
 419                   vec_add1 (rpaths[vec_len (rpaths) - 1].frp_label_stack,
 420                             out_label);
 421                 }
 422             }
 423         }
 424       else if (unformat (line_input, "via-label %U",
 425                          unformat_mpls_unicast_label, &rpath.frp_local_label))
 426         {
 427           rpath.frp_weight = 1;
 428           rpath.frp_eos = MPLS_NON_EOS;
 429           rpath.frp_proto = DPO_PROTO_MPLS;
 430           rpath.frp_sw_if_index = ~0;
 431           vec_add1 (rpaths, rpath);
 432         }
 433       else if (unformat (line_input, "count %f", &count))
 434         ;
 435
 436       else if (unformat (line_input, "%U/%d",
 437                          unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
 438         {
 439           pfx.fp_proto = FIB_PROTOCOL_IP4;
 440           vec_add1 (prefixs, pfx);
 441         }
 442       else if (unformat (line_input, "%U/%d",
 443                          unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
 444         {
 445           pfx.fp_proto = FIB_PROTOCOL_IP6;
 446           vec_add1 (prefixs, pfx);
 447         }
 448       else if (unformat (line_input, "via %U %U",
 449                          unformat_ip4_address,
 450                          &rpath.frp_addr.ip4,
 451                          unformat_vnet_sw_interface, vnm,
 452                          &rpath.frp_sw_if_index))
 453         {
 454           rpath.frp_weight = 1;
 455           rpath.frp_proto = DPO_PROTO_IP4;
 456           vec_add1 (rpaths, rpath);
 457         }
 458
 459       else if (unformat (line_input, "via %U %U",
 460                          unformat_ip6_address,
 461                          &rpath.frp_addr.ip6,
 462                          unformat_vnet_sw_interface, vnm,
 463                          &rpath.frp_sw_if_index))
 464         {
 465           rpath.frp_weight = 1;
 466           rpath.frp_proto = DPO_PROTO_IP6;
 467           vec_add1 (rpaths, rpath);
 468         }
 469       else if (unformat (line_input, "weight %u", &weight))
 470         {
 471           ASSERT (vec_len (rpaths));
 472           rpaths[vec_len (rpaths) - 1].frp_weight = weight;
 473         }
 474       else if (unformat (line_input, "preference %u", &preference))
 475         {
 476           ASSERT (vec_len (rpaths));
 477           rpaths[vec_len (rpaths) - 1].frp_preference = preference;
 478         }
 479       else if (unformat (line_input, "via %U next-hop-table %d",
 480                          unformat_ip4_address,
 481                          &rpath.frp_addr.ip4, &rpath.frp_fib_index))
 482         {
 483           rpath.frp_weight = 1;
 484           rpath.frp_sw_if_index = ~0;
 485           rpath.frp_proto = DPO_PROTO_IP4;
 486           vec_add1 (rpaths, rpath);
 487         }
 488       else if (unformat (line_input, "via %U next-hop-table %d",
 489                          unformat_ip6_address,
 490                          &rpath.frp_addr.ip6, &rpath.frp_fib_index))
 491         {
 492           rpath.frp_weight = 1;
 493           rpath.frp_sw_if_index = ~0;
 494           rpath.frp_proto = DPO_PROTO_IP6;
 495           vec_add1 (rpaths, rpath);
 496         }
 497       else if (unformat (line_input, "via %U",
 498                          unformat_ip4_address, &rpath.frp_addr.ip4))
 499         {
 500           /*
 501            * the recursive next-hops are by default in the same table
 502            * as the prefix
 503            */
 504           rpath.frp_fib_index = table_id;
 505           rpath.frp_weight = 1;
 506           rpath.frp_sw_if_index = ~0;
 507           rpath.frp_proto = DPO_PROTO_IP4;
 508           vec_add1 (rpaths, rpath);
 509         }
 510       else if (unformat (line_input, "via %U",
 511                          unformat_ip6_address, &rpath.frp_addr.ip6))
 512         {
 513           rpath.frp_fib_index = table_id;
 514           rpath.frp_weight = 1;
 515           rpath.frp_sw_if_index = ~0;
 516           rpath.frp_proto = DPO_PROTO_IP6;
 517           vec_add1 (rpaths, rpath);
 518         }
 519       else if (unformat (line_input,
 520                          "lookup in table %d", &rpath.frp_fib_index))
 521         {
 522           rpath.frp_proto = fib_proto_to_dpo (pfx.fp_proto);
 523           rpath.frp_sw_if_index = ~0;
 524           vec_add1 (rpaths, rpath);
 525         }
 526       else if (vec_len (prefixs) > 0 &&
 527                unformat (line_input, "via %U",
 528                          unformat_vnet_sw_interface, vnm,
 529                          &rpath.frp_sw_if_index))
 530         {
 531           rpath.frp_weight = 1;
 532           rpath.frp_proto = fib_proto_to_dpo (prefixs[0].fp_proto);
 533           vec_add1 (rpaths, rpath);
 534         }
 535       else if (vec_len (prefixs) > 0 &&
 536                unformat (line_input, "via %U",
 537                          unformat_dpo, &dpo, prefixs[0].fp_proto))
 538         {
 539           vec_add1 (dpos, dpo);
 540         }
 541       else if (unformat (line_input, "del"))
 542         is_del = 1;
 543       else if (unformat (line_input, "add"))
 544         is_del = 0;
 545       else
 546         {
 547           error = unformat_parse_error (line_input);
 548           goto done;
 549         }
 550     }
 551
 552   if (vec_len (prefixs) == 0)
 553     {
 554       error =
 555         clib_error_return (0, "expected ip4/ip6 destination address/length.");
 556       goto done;
 557     }
 558
 559   if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
 560     {
 561       error = clib_error_return (0, "expected paths.");
 562       goto done;
 563     }
 564
 565   if (~0 == table_id)
 566     {
 567       /*
 568        * if no table_id is passed we will manipulate the default
 569        */
 570       fib_index = 0;
 571     }
 572   else
 573     {
 574       fib_index = fib_table_find (prefixs[0].fp_proto, table_id);
 575
 576       if (~0 == fib_index)
 577         {
 578           error = clib_error_return (0, "Nonexistent table id %d", table_id);
 579           goto done;
 580         }
 581     }
 582
 583   for (i = 0; i < vec_len (prefixs); i++)
 584     {
 585       if (is_del && 0 == vec_len (rpaths))
 586         {
 587           fib_table_entry_delete (fib_index, &prefixs[i], FIB_SOURCE_CLI);
 588         }
 589       else if (!is_del && 1 == vec_len (dpos))
 590         {
 591           fib_table_entry_special_dpo_add (fib_index,
 592                                            &prefixs[i],
 593                                            FIB_SOURCE_CLI,
 594                                            FIB_ENTRY_FLAG_EXCLUSIVE,
 595                                            &dpos[0]);
 596           dpo_reset (&dpos[0]);
 597         }
 598       else if (vec_len (dpos) > 0)
 599         {
 600           error =
 601             clib_error_return (0,
 602                                "Load-balancing over multiple special adjacencies is unsupported");
 603           goto done;
 604         }
 605       else if (0 < vec_len (rpaths))
 606         {
 607           u32 k, j, n, incr;
 608           ip46_address_t dst = prefixs[i].fp_addr;
 609           f64 t[2];
 610           n = count;
 611           t[0] = vlib_time_now (vm);
 612           incr = 1 << ((FIB_PROTOCOL_IP4 == prefixs[0].fp_proto ? 32 : 128) -
 613                        prefixs[i].fp_len);
 614
 615           for (k = 0; k < n; k++)
 616             {
 617               for (j = 0; j < vec_len (rpaths); j++)
 618                 {
 619                   u32 fi;
 620                   /*
 621                    * the CLI parsing stored table Ids, swap to FIB indicies
 622                    */
 623                   fi = fib_table_find (prefixs[i].fp_proto,
 624                                        rpaths[i].frp_fib_index);
 625
 626                   if (~0 == fi)
 627                     {
 628                       error =
 629                         clib_error_return (0, "Via table %d does not exist",
 630                                            rpaths[i].frp_fib_index);
 631                       goto done;
 632                     }
 633                   rpaths[i].frp_fib_index = fi;
 634
 635                   fib_prefix_t rpfx = {
 636                     .fp_len = prefixs[i].fp_len,
 637                     .fp_proto = prefixs[i].fp_proto,
 638                     .fp_addr = dst,
 639                   };
 640
 641                   if (is_del)
 642                     fib_table_entry_path_remove2 (fib_index,
 643                                                   &rpfx,
 644                                                   FIB_SOURCE_CLI, &rpaths[j]);
 645                   else
 646                     fib_table_entry_path_add2 (fib_index,
 647                                                &rpfx,
 648                                                FIB_SOURCE_CLI,
 649                                                FIB_ENTRY_FLAG_NONE,
 650                                                &rpaths[j]);
 651                 }
 652
 653               if (FIB_PROTOCOL_IP4 == prefixs[0].fp_proto)
 654                 {
 655                   dst.ip4.as_u32 =
 656                     clib_host_to_net_u32 (incr +
 657                                           clib_net_to_host_u32 (dst.
 658                                                                 ip4.as_u32));
 659                 }
 660               else
 661                 {
 662                   int bucket = (incr < 64 ? 0 : 1);
 663                   dst.ip6.as_u64[bucket] =
 664                     clib_host_to_net_u64 (incr +
 665                                           clib_net_to_host_u64 (dst.ip6.as_u64
 666                                                                 [bucket]));
 667
 668                 }
 669             }
 670           t[1] = vlib_time_now (vm);
 671           if (count > 1)
 672             vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
 673         }
 674       else
 675         {
 676           error = clib_error_return (0, "Don't understand what you want...");
 677           goto done;
 678         }
 679     }
 680
 681
 682 done:
 683   vec_free (dpos);
 684   vec_free (prefixs);
 685   vec_free (rpaths);
 686   unformat_free (line_input);
 687   return error;
 688 }
 689
 690 clib_error_t *
 691 vnet_ip_table_cmd (vlib_main_t * vm,
 692                    unformat_input_t * main_input,
 693                    vlib_cli_command_t * cmd, fib_protocol_t fproto)
 694 {
 695   unformat_input_t _line_input, *line_input = &_line_input;
 696   clib_error_t *error = NULL;
 697   u32 table_id, is_add;
 698   u8 *name = NULL;
 699
 700   is_add = 1;
 701   table_id = ~0;
 702
 703   /* Get a line of input. */
 704   if (!unformat_user (main_input, unformat_line_input, line_input))
 705     return 0;
 706
 707   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 708     {
 709       if (unformat (line_input, "%d", &table_id))
 710         ;
 711       else if (unformat (line_input, "del"))
 712         is_add = 0;
 713       else if (unformat (line_input, "add"))
 714         is_add = 1;
 715       else if (unformat (line_input, "name %s", &name))
 716         ;
 717       else
 718         {
 719           error = unformat_parse_error (line_input);
 720           goto done;
 721         }
 722     }
 723
 724   if (~0 == table_id)
 725     {
 726       error = clib_error_return (0, "No table id");
 727       goto done;
 728     }
 729   else if (0 == table_id)
 730     {
 731       error = clib_error_return (0, "Can't change the default table");
 732       goto done;
 733     }
 734   else
 735     {
 736       if (is_add)
 737         {
 738           ip_table_create (fproto, table_id, 0, name);
 739         }
 740       else
 741         {
 742           ip_table_delete (fproto, table_id, 0);
 743         }
 744     }
 745
 746 done:
 747   unformat_free (line_input);
 748   return error;
 749 }
 750
 751 clib_error_t *
 752 vnet_ip4_table_cmd (vlib_main_t * vm,
 753                     unformat_input_t * main_input, vlib_cli_command_t * cmd)
 754 {
 755   return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP4));
 756 }
 757
 758 clib_error_t *
 759 vnet_ip6_table_cmd (vlib_main_t * vm,
 760                     unformat_input_t * main_input, vlib_cli_command_t * cmd)
 761 {
 762   return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP6));
 763 }
 764
 765 /* *INDENT-OFF* */
 766 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
 767   .path = "ip",
 768   .short_help = "Internet protocol (IP) commands",
 769 };
 770 /* *INDENT-ON* */
 771
 772 /* *INDENT-OFF* */
 773 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
 774   .path = "ip6",
 775   .short_help = "Internet protocol version 6 (IPv6) commands",
 776 };
 777 /* *INDENT-ON* */
 778
 779 /* *INDENT-OFF* */
 780 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
 781   .path = "show ip",
 782   .short_help = "Internet protocol (IP) show commands",
 783 };
 784 /* *INDENT-ON* */
 785
 786 /* *INDENT-OFF* */
 787 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
 788   .path = "show ip6",
 789   .short_help = "Internet protocol version 6 (IPv6) show commands",
 790 };
 791 /* *INDENT-ON* */
 792
 793 /*?
 794  * This command is used to add or delete IPv4 or IPv6 routes. All
 795  * IP Addresses ('<em><dst-ip-addr>/<width></em>',
 796  * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
 797  * can be IPv4 or IPv6, but all must be of the same form in a single
 798  * command. To display the current set of routes, use the commands
 799  * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
 800  *
 801  * @cliexpar
 802  * Example of how to add a straight forward static route:
 803  * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
 804  * Example of how to delete a straight forward static route:
 805  * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
 806  * Mainly for route add/del performance testing, one can add or delete
 807  * multiple routes by adding 'count N' to the previous item:
 808  * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
 809  * Add multiple routes for the same destination to create equal-cost multipath:
 810  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
 811  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
 812  * For unequal-cost multipath, specify the desired weights. This
 813  * combination of weights results in 3/4 of the traffic following the
 814  * second path, 1/4 following the first path:
 815  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
 816  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
 817  * To add a route to a particular FIB table (VRF), use:
 818  * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
 819  ?*/
 820 /* *INDENT-OFF* */
 821 VLIB_CLI_COMMAND (ip_route_command, static) = {
 822   .path = "ip route",
 823   .short_help = "ip route [add|del] [count <n>] <dst-ip-addr>/<width> [table <table-id>] [via <next-hop-ip-addr> [<interface>] [weight <weight>]] | [via arp <interface> <adj-hop-ip-addr>] | [via drop|punt|local<id>|arp|classify <classify-idx>] [lookup in table <out-table-id>]",
 824   .function = vnet_ip_route_cmd,
 825   .is_mp_safe = 1,
 826 };
 827
 828 /* *INDENT-ON* */
 829 /*?
 830  * This command is used to add or delete IPv4  Tables. All
 831  * Tables must be explicitly added before that can be used. Creating a
 832  * table will add both unicast and multicast FIBs
 833  *
 834  ?*/
 835 /* *INDENT-OFF* */
 836 VLIB_CLI_COMMAND (ip4_table_command, static) = {
 837   .path = "ip table",
 838   .short_help = "ip table [add|del] <table-id>",
 839   .function = vnet_ip4_table_cmd,
 840   .is_mp_safe = 1,
 841 };
 842 /* *INDENT-ON* */
 843
 844 /* *INDENT-ON* */
 845 /*?
 846  * This command is used to add or delete IPv4  Tables. All
 847  * Tables must be explicitly added before that can be used. Creating a
 848  * table will add both unicast and multicast FIBs
 849  *
 850  ?*/
 851 /* *INDENT-OFF* */
 852 VLIB_CLI_COMMAND (ip6_table_command, static) = {
 853   .path = "ip6 table",
 854   .short_help = "ip6 table [add|del] <table-id>",
 855   .function = vnet_ip6_table_cmd,
 856   .is_mp_safe = 1,
 857 };
 858
 859 static clib_error_t *
 860 ip_table_bind_cmd (vlib_main_t * vm,
 861                    unformat_input_t * input,
 862                    vlib_cli_command_t * cmd,
 863                    fib_protocol_t fproto)
 864 {
 865   vnet_main_t *vnm = vnet_get_main ();
 866   clib_error_t *error = 0;
 867   u32 sw_if_index, table_id;
 868   int rv;
 869
 870   sw_if_index = ~0;
 871
 872   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 873     {
 874       error = clib_error_return (0, "unknown interface `%U'",
 875                                  format_unformat_error, input);
 876       goto done;
 877     }
 878
 879   if (unformat (input, "%d", &table_id))
 880     ;
 881   else
 882     {
 883       error = clib_error_return (0, "expected table id `%U'",
 884                                  format_unformat_error, input);
 885       goto done;
 886     }
 887
 888   rv = ip_table_bind (fproto, sw_if_index, table_id, 0);
 889
 890   if (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE == rv)
 891     {
 892       error = clib_error_return (0, "IP addresses are still present on %U",
 893                                  format_vnet_sw_if_index_name,
 894                                  vnet_get_main(),
 895                                  sw_if_index);
 896     }
 897   else if (VNET_API_ERROR_NO_SUCH_FIB == rv)
 898     {
 899       error = clib_error_return (0, "no such table %d", table_id);
 900     }
 901   else if (0 != rv)
 902     {
 903       error = clib_error_return (0, "unknown error");
 904     }
 905
 906  done:
 907   return error;
 908 }
 909
 910 static clib_error_t *
 911 ip4_table_bind_cmd (vlib_main_t * vm,
 912                     unformat_input_t * input,
 913                     vlib_cli_command_t * cmd)
 914 {
 915   return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP4));
 916 }
 917
 918 static clib_error_t *
 919 ip6_table_bind_cmd (vlib_main_t * vm,
 920                     unformat_input_t * input,
 921                     vlib_cli_command_t * cmd)
 922 {
 923   return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP6));
 924 }
 925
 926 /*?
 927  * Place the indicated interface into the supplied IPv4 FIB table (also known
 928  * as a VRF). If the FIB table does not exist, this command creates it. To
 929  * display the current IPv4 FIB table, use the command '<em>show ip fib</em>'.
 930  * FIB table will only be displayed if a route has been added to the table, or
 931  * an IP Address is assigned to an interface in the table (which adds a route
 932  * automatically).
 933  *
 934  * @note IP addresses added after setting the interface IP table are added to
 935  * the indicated FIB table. If an IP address is added prior to changing the
 936  * table then this is an error. The control plane must remove these addresses
 937  * first and then change the table. VPP will not automatically move the
 938  * addresses from the old to the new table as it does not know the validity
 939  * of such a change.
 940  *
 941  * @cliexpar
 942  * Example of how to add an interface to an IPv4 FIB table (where 2 is the table-id):
 943  * @cliexcmd{set interface ip table GigabitEthernet2/0/0 2}
 944  ?*/
 945 /* *INDENT-OFF* */
 946 VLIB_CLI_COMMAND (set_interface_ip_table_command, static) =
 947 {
 948   .path = "set interface ip table",
 949   .function = ip4_table_bind_cmd,
 950   .short_help = "set interface ip table <interface> <table-id>",
 951 };
 952 /* *INDENT-ON* */
 953
 954 /*?
 955  * Place the indicated interface into the supplied IPv6 FIB table (also known
 956  * as a VRF). If the FIB table does not exist, this command creates it. To
 957  * display the current IPv6 FIB table, use the command '<em>show ip6 fib</em>'.
 958  * FIB table will only be displayed if a route has been added to the table, or
 959  * an IP Address is assigned to an interface in the table (which adds a route
 960  * automatically).
 961  *
 962  * @note IP addresses added after setting the interface IP table are added to
 963  * the indicated FIB table. If an IP address is added prior to changing the
 964  * table then this is an error. The control plane must remove these addresses
 965  * first and then change the table. VPP will not automatically move the
 966  * addresses from the old to the new table as it does not know the validity
 967  * of such a change.
 968  *
 969  * @cliexpar
 970  * Example of how to add an interface to an IPv6 FIB table (where 2 is the table-id):
 971  * @cliexcmd{set interface ip6 table GigabitEthernet2/0/0 2}
 972  ?*/
 973 /* *INDENT-OFF* */
 974 VLIB_CLI_COMMAND (set_interface_ip6_table_command, static) =
 975 {
 976   .path = "set interface ip6 table",
 977   .function = ip6_table_bind_cmd,
 978   .short_help = "set interface ip6 table <interface> <table-id>"
 979 };
 980 /* *INDENT-ON* */
 981
 982 clib_error_t *
 983 vnet_ip_mroute_cmd (vlib_main_t * vm,
 984                     unformat_input_t * main_input, vlib_cli_command_t * cmd)
 985 {
 986   unformat_input_t _line_input, *line_input = &_line_input;
 987   clib_error_t *error = NULL;
 988   fib_route_path_t rpath;
 989   u32 table_id, is_del;
 990   vnet_main_t *vnm;
 991   mfib_prefix_t pfx;
 992   u32 fib_index;
 993   mfib_itf_flags_t iflags = 0;
 994   mfib_entry_flags_t eflags = 0;
 995   u32 gcount, scount, ss, gg, incr;
 996   f64 timet[2];
 997
 998   gcount = scount = 1;
 999   vnm = vnet_get_main ();
1000   is_del = 0;
1001   table_id = 0;
1002   memset (&pfx, 0, sizeof (pfx));
1003   memset (&rpath, 0, sizeof (rpath));
1004   rpath.frp_sw_if_index = ~0;
1005
1006   /* Get a line of input. */
1007   if (!unformat_user (main_input, unformat_line_input, line_input))
1008     return 0;
1009
1010   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1011     {
1012       if (unformat (line_input, "table %d", &table_id))
1013         ;
1014       else if (unformat (line_input, "del"))
1015         is_del = 1;
1016       else if (unformat (line_input, "add"))
1017         is_del = 0;
1018       else if (unformat (line_input, "scount %d", &scount))
1019         ;
1020       else if (unformat (line_input, "gcount %d", &gcount))
1021         ;
1022       else if (unformat (line_input, "%U %U",
1023                          unformat_ip4_address,
1024                          &pfx.fp_src_addr.ip4,
1025                          unformat_ip4_address, &pfx.fp_grp_addr.ip4))
1026         {
1027           pfx.fp_proto = FIB_PROTOCOL_IP4;
1028           pfx.fp_len = 64;
1029         }
1030       else if (unformat (line_input, "%U %U",
1031                          unformat_ip6_address,
1032                          &pfx.fp_src_addr.ip6,
1033                          unformat_ip6_address, &pfx.fp_grp_addr.ip6))
1034         {
1035           pfx.fp_proto = FIB_PROTOCOL_IP6;
1036           pfx.fp_len = 256;
1037         }
1038       else if (unformat (line_input, "%U/%d",
1039                          unformat_ip4_address,
1040                          &pfx.fp_grp_addr.ip4, &pfx.fp_len))
1041         {
1042           memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
1043           pfx.fp_proto = FIB_PROTOCOL_IP4;
1044         }
1045       else if (unformat (line_input, "%U/%d",
1046                          unformat_ip6_address,
1047                          &pfx.fp_grp_addr.ip6, &pfx.fp_len))
1048         {
1049           memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
1050           pfx.fp_proto = FIB_PROTOCOL_IP6;
1051         }
1052       else if (unformat (line_input, "%U",
1053                          unformat_ip4_address, &pfx.fp_grp_addr.ip4))
1054         {
1055           memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
1056           pfx.fp_proto = FIB_PROTOCOL_IP4;
1057           pfx.fp_len = 32;
1058         }
1059       else if (unformat (line_input, "%U",
1060                          unformat_ip6_address, &pfx.fp_grp_addr.ip6))
1061         {
1062           memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
1063           pfx.fp_proto = FIB_PROTOCOL_IP6;
1064           pfx.fp_len = 128;
1065         }
1066       else if (unformat (line_input, "via %U",
1067                          unformat_vnet_sw_interface, vnm,
1068                          &rpath.frp_sw_if_index))
1069         {
1070           rpath.frp_weight = 1;
1071         }
1072       else if (unformat (line_input, "via local"))
1073         {
1074           rpath.frp_sw_if_index = ~0;
1075           rpath.frp_weight = 1;
1076           rpath.frp_flags |= FIB_ROUTE_PATH_LOCAL;
1077         }
1078       else if (unformat (line_input, "%U", unformat_mfib_itf_flags, &iflags))
1079         ;
1080       else if (unformat (line_input, "%U",
1081                          unformat_mfib_entry_flags, &eflags))
1082         ;
1083       else
1084         {
1085           error = unformat_parse_error (line_input);
1086           goto done;
1087         }
1088     }
1089
1090   if (~0 == table_id)
1091     {
1092       /*
1093        * if no table_id is passed we will manipulate the default
1094        */
1095       fib_index = 0;
1096     }
1097   else
1098     {
1099       fib_index = mfib_table_find (pfx.fp_proto, table_id);
1100
1101       if (~0 == fib_index)
1102         {
1103           error = clib_error_return (0, "Nonexistent table id %d", table_id);
1104           goto done;
1105         }
1106     }
1107
1108   timet[0] = vlib_time_now (vm);
1109
1110   if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1111     {
1112       incr = 1 << (32 - (pfx.fp_len % 32));
1113     }
1114   else
1115     {
1116       incr = 1 << (128 - (pfx.fp_len % 128));
1117     }
1118
1119   for (ss = 0; ss < scount; ss++)
1120     {
1121       for (gg = 0; gg < gcount; gg++)
1122         {
1123           if (is_del && 0 == rpath.frp_weight)
1124             {
1125               /* no path provided => route delete */
1126               mfib_table_entry_delete (fib_index, &pfx, MFIB_SOURCE_CLI);
1127             }
1128           else if (eflags)
1129             {
1130               mfib_table_entry_update (fib_index, &pfx, MFIB_SOURCE_CLI,
1131                                        MFIB_RPF_ID_NONE, eflags);
1132             }
1133           else
1134             {
1135               if (is_del)
1136                 mfib_table_entry_path_remove (fib_index,
1137                                               &pfx, MFIB_SOURCE_CLI, &rpath);
1138               else
1139                 mfib_table_entry_path_update (fib_index,
1140                                               &pfx, MFIB_SOURCE_CLI, &rpath,
1141                                               iflags);
1142             }
1143
1144           if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1145             {
1146               pfx.fp_grp_addr.ip4.as_u32 =
1147                 clib_host_to_net_u32 (incr +
1148                                       clib_net_to_host_u32 (pfx.
1149                                                             fp_grp_addr.ip4.
1150                                                             as_u32));
1151             }
1152           else
1153             {
1154               int bucket = (incr < 64 ? 0 : 1);
1155               pfx.fp_grp_addr.ip6.as_u64[bucket] =
1156                 clib_host_to_net_u64 (incr +
1157                                       clib_net_to_host_u64 (pfx.
1158                                                             fp_grp_addr.ip6.as_u64
1159                                                             [bucket]));
1160
1161             }
1162         }
1163       if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1164         {
1165           pfx.fp_src_addr.ip4.as_u32 =
1166             clib_host_to_net_u32 (1 +
1167                                   clib_net_to_host_u32 (pfx.fp_src_addr.
1168                                                         ip4.as_u32));
1169         }
1170       else
1171         {
1172           pfx.fp_src_addr.ip6.as_u64[1] =
1173             clib_host_to_net_u64 (1 +
1174                                   clib_net_to_host_u64 (pfx.fp_src_addr.
1175                                                         ip6.as_u64[1]));
1176         }
1177     }
1178
1179   timet[1] = vlib_time_now (vm);
1180
1181   if (scount > 1 || gcount > 1)
1182     vlib_cli_output (vm, "%.6e routes/sec",
1183                      (scount * gcount) / (timet[1] - timet[0]));
1184
1185 done:
1186   unformat_free (line_input);
1187
1188   return error;
1189 }
1190
1191 /*?
1192  * This command is used to add or delete IPv4 or IPv6  multicastroutes. All
1193  * IP Addresses ('<em><dst-ip-addr>/<width></em>',
1194  * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
1195  * can be IPv4 or IPv6, but all must be of the same form in a single
1196  * command. To display the current set of routes, use the commands
1197  * '<em>show ip mfib</em>' and '<em>show ip6 mfib</em>'.
1198  * The full set of support flags for interfaces and route is shown via;
1199  * '<em>show mfib route flags</em>' and '<em>show mfib itf flags</em>'
1200  * respectively.
1201  * @cliexpar
1202  * Example of how to add a forwarding interface to a route (and create the
1203  * route if it does not exist)
1204  * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/0 Forward}
1205  * Example of how to add an accepting interface to a route (and create the
1206  * route if it does not exist)
1207  * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/1 Accept}
1208  * Example of changing the route's flags to send signals via the API
1209  * @cliexcmd{ip mroute add 232.1.1.1 Signal}
1210
1211  ?*/
1212 /* *INDENT-OFF* */
1213 VLIB_CLI_COMMAND (ip_mroute_command, static) =
1214 {
1215   .path = "ip mroute",
1216   .short_help = "ip mroute [add|del] <dst-ip-addr>/<width> [table <table-id>] [via <next-hop-ip-addr> [<interface>],",
1217   .function = vnet_ip_mroute_cmd,
1218   .is_mp_safe = 1,
1219 };
1220 /* *INDENT-ON* */
1221
1222 /*
1223  * The next two routines address a longstanding script hemorrhoid.
1224  * Probing a v4 or v6 neighbor needs to appear to be synchronous,
1225  * or dependent route-adds will simply fail.
1226  */
1227 static clib_error_t *
1228 ip6_probe_neighbor_wait (vlib_main_t * vm, ip6_address_t * a, u32 sw_if_index,
1229                          int retry_count)
1230 {
1231   vnet_main_t *vnm = vnet_get_main ();
1232   clib_error_t *e;
1233   int i;
1234   int resolved = 0;
1235   uword event_type;
1236   uword *event_data = 0;
1237
1238   ASSERT (vlib_in_process_context (vm));
1239
1240   if (retry_count > 0)
1241     vnet_register_ip6_neighbor_resolution_event
1242       (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1243        1 /* event */ , 0 /* data */ );
1244
1245   for (i = 0; i < retry_count; i++)
1246     {
1247       /* The interface may be down, etc. */
1248       e = ip6_probe_neighbor (vm, a, sw_if_index);
1249
1250       if (e)
1251         return e;
1252
1253       vlib_process_wait_for_event_or_clock (vm, 1.0);
1254       event_type = vlib_process_get_events (vm, &event_data);
1255       switch (event_type)
1256         {
1257         case 1:         /* resolved... */
1258           vlib_cli_output (vm, "Resolved %U", format_ip6_address, a);
1259           resolved = 1;
1260           goto done;
1261
1262         case ~0:                /* timeout */
1263           break;
1264
1265         default:
1266           clib_warning ("unknown event_type %d", event_type);
1267         }
1268       vec_reset_length (event_data);
1269     }
1270
1271 done:
1272
1273   if (!resolved)
1274     return clib_error_return (0, "Resolution failed for %U",
1275                               format_ip6_address, a);
1276   return 0;
1277 }
1278
1279 static clib_error_t *
1280 ip4_probe_neighbor_wait (vlib_main_t * vm, ip4_address_t * a, u32 sw_if_index,
1281                          int retry_count)
1282 {
1283   vnet_main_t *vnm = vnet_get_main ();
1284   clib_error_t *e;
1285   int i;
1286   int resolved = 0;
1287   uword event_type;
1288   uword *event_data = 0;
1289
1290   ASSERT (vlib_in_process_context (vm));
1291
1292   if (retry_count > 0)
1293     vnet_register_ip4_arp_resolution_event
1294       (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1295        1 /* event */ , 0 /* data */ );
1296
1297   for (i = 0; i < retry_count; i++)
1298     {
1299       /* The interface may be down, etc. */
1300       e = ip4_probe_neighbor (vm, a, sw_if_index);
1301
1302       if (e)
1303         return e;
1304
1305       vlib_process_wait_for_event_or_clock (vm, 1.0);
1306       event_type = vlib_process_get_events (vm, &event_data);
1307       switch (event_type)
1308         {
1309         case 1:         /* resolved... */
1310           vlib_cli_output (vm, "Resolved %U", format_ip4_address, a);
1311           resolved = 1;
1312           goto done;
1313
1314         case ~0:                /* timeout */
1315           break;
1316
1317         default:
1318           clib_warning ("unknown event_type %d", event_type);
1319         }
1320       vec_reset_length (event_data);
1321     }
1322
1323 done:
1324
1325   vec_reset_length (event_data);
1326
1327   if (!resolved)
1328     return clib_error_return (0, "Resolution failed for %U",
1329                               format_ip4_address, a);
1330   return 0;
1331 }
1332
1333 static clib_error_t *
1334 probe_neighbor_address (vlib_main_t * vm,
1335                         unformat_input_t * input, vlib_cli_command_t * cmd)
1336 {
1337   vnet_main_t *vnm = vnet_get_main ();
1338   unformat_input_t _line_input, *line_input = &_line_input;
1339   ip4_address_t a4;
1340   ip6_address_t a6;
1341   clib_error_t *error = 0;
1342   u32 sw_if_index = ~0;
1343   int retry_count = 3;
1344   int is_ip4 = 1;
1345   int address_set = 0;
1346
1347   /* Get a line of input. */
1348   if (!unformat_user (input, unformat_line_input, line_input))
1349     return 0;
1350
1351   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1352     {
1353       if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
1354                          &sw_if_index))
1355         ;
1356       else if (unformat (line_input, "retry %d", &retry_count))
1357         ;
1358
1359       else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
1360         address_set++;
1361       else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
1362         {
1363           address_set++;
1364           is_ip4 = 0;
1365         }
1366       else
1367         {
1368           error = clib_error_return (0, "unknown input '%U'",
1369                                      format_unformat_error, line_input);
1370           goto done;
1371         }
1372     }
1373
1374   if (sw_if_index == ~0)
1375     {
1376       error = clib_error_return (0, "Interface required, not set.");
1377       goto done;
1378     }
1379   if (address_set == 0)
1380     {
1381       error = clib_error_return (0, "ip address required, not set.");
1382       goto done;
1383     }
1384   if (address_set > 1)
1385     {
1386       error = clib_error_return (0, "Multiple ip addresses not supported.");
1387       goto done;
1388     }
1389
1390   if (is_ip4)
1391     error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
1392   else
1393     error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
1394
1395 done:
1396   unformat_free (line_input);
1397
1398   return error;
1399 }
1400
1401 /*?
1402  * The '<em>ip probe-neighbor</em>' command ARPs for IPv4 addresses or
1403  * attempts IPv6 neighbor discovery depending on the supplied IP address
1404  * format.
1405  *
1406  * @note This command will not immediately affect the indicated FIB; it
1407  * is not suitable for use in establishing a FIB entry prior to adding
1408  * recursive FIB entries. As in: don't use it in a script to probe a
1409  * gateway prior to adding a default route. It won't work. Instead,
1410  * configure a static ARP cache entry [see '<em>set ip arp</em>'], or
1411  * a static IPv6 neighbor [see '<em>set ip6 neighbor</em>'].
1412  *
1413  * @cliexpar
1414  * Example of probe for an IPv4 address:
1415  * @cliexcmd{ip probe-neighbor GigabitEthernet2/0/0 172.16.1.2}
1416 ?*/
1417 /* *INDENT-OFF* */
1418 VLIB_CLI_COMMAND (ip_probe_neighbor_command, static) = {
1419   .path = "ip probe-neighbor",
1420   .function = probe_neighbor_address,
1421   .short_help = "ip probe-neighbor <interface> <ip4-addr> | <ip6-addr> [retry nn]",
1422   .is_mp_safe = 1,
1423 };
1424 /* *INDENT-ON* */
1425
1426 /*
1427  * fd.io coding-style-patch-verification: ON
1428  *
1429  * Local Variables:
1430  * eval: (c-set-style "gnu")
1431  * End:
1432  */