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   /* Preallocate three "special" adjacencies */
 195   lm->adjacency_heap = adj_pool;
 196
 197   if (!lm->fib_result_n_bytes)
 198     lm->fib_result_n_bytes = sizeof (uword);
 199
 200   lm->is_ip6 = is_ip6;
 201   if (is_ip6)
 202     {
 203       lm->format_address_and_length = format_ip6_address_and_length;
 204       mhash_init (&lm->address_to_if_address_index, sizeof (uword),
 205                   sizeof (ip6_address_fib_t));
 206     }
 207   else
 208     {
 209       lm->format_address_and_length = format_ip4_address_and_length;
 210       mhash_init (&lm->address_to_if_address_index, sizeof (uword),
 211                   sizeof (ip4_address_fib_t));
 212     }
 213
 214   {
 215     int i;
 216
 217     /* Setup all IP protocols to be punted and builtin-unknown. */
 218     for (i = 0; i < 256; i++)
 219       {
 220         lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
 221         lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
 222       }
 223
 224     lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
 225     lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
 226                                   IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
 227     lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] =
 228       IP_BUILTIN_PROTOCOL_UDP;
 229     lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
 230                                         IP_PROTOCOL_ICMP] =
 231       IP_BUILTIN_PROTOCOL_ICMP;
 232   }
 233 }
 234
 235 u8 *
 236 format_ip_flow_hash_config (u8 * s, va_list * args)
 237 {
 238   flow_hash_config_t flow_hash_config = va_arg (*args, u32);
 239
 240 #define _(n,v) if (flow_hash_config & v) s = format (s, "%s ", #n);
 241   foreach_flow_hash_bit;
 242 #undef _
 243
 244   return s;
 245 }
 246
 247 u8 *
 248 format_ip_lookup_next (u8 * s, va_list * args)
 249 {
 250   /* int promotion of ip_lookup_next_t */
 251   ip_lookup_next_t n = va_arg (*args, int);
 252   char *t = 0;
 253
 254   switch (n)
 255     {
 256     default:
 257       s = format (s, "unknown %d", n);
 258       return s;
 259
 260     case IP_LOOKUP_NEXT_DROP:
 261       t = "drop";
 262       break;
 263     case IP_LOOKUP_NEXT_PUNT:
 264       t = "punt";
 265       break;
 266     case IP_LOOKUP_NEXT_ARP:
 267       t = "arp";
 268       break;
 269     case IP_LOOKUP_NEXT_MIDCHAIN:
 270       t = "midchain";
 271       break;
 272     case IP_LOOKUP_NEXT_GLEAN:
 273       t = "glean";
 274       break;
 275     case IP_LOOKUP_NEXT_MCAST:
 276       t = "mcast";
 277       break;
 278     case IP_LOOKUP_NEXT_REWRITE:
 279       break;
 280     }
 281
 282   if (t)
 283     vec_add (s, t, strlen (t));
 284
 285   return s;
 286 }
 287
 288 u8 *
 289 format_ip_adjacency_packet_data (u8 * s, va_list * args)
 290 {
 291   u32 adj_index = va_arg (*args, u32);
 292   u8 *packet_data = va_arg (*args, u8 *);
 293   u32 n_packet_data_bytes = va_arg (*args, u32);
 294   ip_adjacency_t *adj = adj_get (adj_index);
 295
 296   switch (adj->lookup_next_index)
 297     {
 298     case IP_LOOKUP_NEXT_REWRITE:
 299     case IP_LOOKUP_NEXT_MCAST:
 300       s =
 301         format (s, "%U", format_hex_bytes, packet_data, n_packet_data_bytes);
 302       break;
 303
 304     default:
 305       break;
 306     }
 307
 308   return s;
 309 }
 310
 311 static uword
 312 unformat_dpo (unformat_input_t * input, va_list * args)
 313 {
 314   dpo_id_t *dpo = va_arg (*args, dpo_id_t *);
 315   fib_protocol_t fp = va_arg (*args, int);
 316   dpo_proto_t proto;
 317
 318   proto = fib_proto_to_dpo (fp);
 319
 320   if (unformat (input, "drop"))
 321     dpo_copy (dpo, drop_dpo_get (proto));
 322   else if (unformat (input, "punt"))
 323     dpo_copy (dpo, punt_dpo_get (proto));
 324   else if (unformat (input, "local"))
 325     receive_dpo_add_or_lock (proto, ~0, NULL, dpo);
 326   else if (unformat (input, "null-send-unreach"))
 327     ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_UNREACH, dpo);
 328   else if (unformat (input, "null-send-prohibit"))
 329     ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_PROHIBIT, dpo);
 330   else if (unformat (input, "null"))
 331     ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_NONE, dpo);
 332   else if (unformat (input, "classify"))
 333     {
 334       u32 classify_table_index;
 335
 336       if (!unformat (input, "%d", &classify_table_index))
 337         {
 338           clib_warning ("classify adj must specify table index");
 339           return 0;
 340         }
 341
 342       dpo_set (dpo, DPO_CLASSIFY, proto,
 343                classify_dpo_create (proto, classify_table_index));
 344     }
 345   else
 346     return 0;
 347
 348   return 1;
 349 }
 350
 351 const ip46_address_t zero_addr = {
 352   .as_u64 = {
 353              0, 0},
 354 };
 355
 356 u32
 357 fib_table_id_find_fib_index (fib_protocol_t proto, u32 table_id)
 358 {
 359   ip4_main_t *im4 = &ip4_main;
 360   ip6_main_t *im6 = &ip6_main;
 361   uword *p;
 362
 363   switch (proto)
 364     {
 365     case FIB_PROTOCOL_IP4:
 366       p = hash_get (im4->fib_index_by_table_id, table_id);
 367       break;
 368     case FIB_PROTOCOL_IP6:
 369       p = hash_get (im6->fib_index_by_table_id, table_id);
 370       break;
 371     default:
 372       p = NULL;
 373       break;
 374     }
 375   if (NULL != p)
 376     {
 377       return (p[0]);
 378     }
 379   return (~0);
 380 }
 381
 382 clib_error_t *
 383 vnet_ip_route_cmd (vlib_main_t * vm,
 384                    unformat_input_t * main_input, vlib_cli_command_t * cmd)
 385 {
 386   unformat_input_t _line_input, *line_input = &_line_input;
 387   fib_route_path_t *rpaths = NULL, rpath;
 388   dpo_id_t dpo = DPO_INVALID, *dpos = NULL;
 389   fib_prefix_t *prefixs = NULL, pfx;
 390   mpls_label_t out_label, via_label;
 391   clib_error_t *error = NULL;
 392   u32 table_id, is_del;
 393   vnet_main_t *vnm;
 394   u32 fib_index;
 395   f64 count;
 396   int i;
 397
 398   vnm = vnet_get_main ();
 399   is_del = 0;
 400   table_id = 0;
 401   count = 1;
 402   memset (&pfx, 0, sizeof (pfx));
 403   out_label = via_label = MPLS_LABEL_INVALID;
 404
 405   /* Get a line of input. */
 406   if (!unformat_user (main_input, unformat_line_input, line_input))
 407     return 0;
 408
 409   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 410     {
 411       memset (&rpath, 0, sizeof (rpath));
 412
 413       if (unformat (line_input, "table %d", &table_id))
 414         ;
 415       else if (unformat (line_input, "del"))
 416         is_del = 1;
 417       else if (unformat (line_input, "add"))
 418         is_del = 0;
 419       else if (unformat (line_input, "resolve-via-host"))
 420         {
 421           if (vec_len (rpaths) == 0)
 422             {
 423               error = clib_error_return (0, "Paths then flags");
 424               goto done;
 425             }
 426           rpaths[vec_len (rpaths) - 1].frp_flags |=
 427             FIB_ROUTE_PATH_RESOLVE_VIA_HOST;
 428         }
 429       else if (unformat (line_input, "resolve-via-attached"))
 430         {
 431           if (vec_len (rpaths) == 0)
 432             {
 433               error = clib_error_return (0, "Paths then flags");
 434               goto done;
 435             }
 436           rpaths[vec_len (rpaths) - 1].frp_flags |=
 437             FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED;
 438         }
 439       else if (unformat (line_input, "out-label %U",
 440                          unformat_mpls_unicast_label, &out_label))
 441         {
 442           if (vec_len (rpaths) == 0)
 443             {
 444               error = clib_error_return (0, "Paths then labels");
 445               goto done;
 446             }
 447           vec_add1 (rpaths[vec_len (rpaths) - 1].frp_label_stack, out_label);
 448         }
 449       else if (unformat (line_input, "via-label %U",
 450                          unformat_mpls_unicast_label, &rpath.frp_local_label))
 451         {
 452           rpath.frp_weight = 1;
 453           rpath.frp_proto = FIB_PROTOCOL_MPLS;
 454           rpath.frp_sw_if_index = ~0;
 455           vec_add1 (rpaths, rpath);
 456         }
 457       else if (unformat (line_input, "count %f", &count))
 458         ;
 459
 460       else if (unformat (line_input, "%U/%d",
 461                          unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
 462         {
 463           pfx.fp_proto = FIB_PROTOCOL_IP4;
 464           vec_add1 (prefixs, pfx);
 465         }
 466       else if (unformat (line_input, "%U/%d",
 467                          unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
 468         {
 469           pfx.fp_proto = FIB_PROTOCOL_IP6;
 470           vec_add1 (prefixs, pfx);
 471         }
 472       else if (unformat (line_input, "via %U %U weight %u",
 473                          unformat_ip4_address,
 474                          &rpath.frp_addr.ip4,
 475                          unformat_vnet_sw_interface, vnm,
 476                          &rpath.frp_sw_if_index, &rpath.frp_weight))
 477         {
 478           rpath.frp_proto = FIB_PROTOCOL_IP4;
 479           vec_add1 (rpaths, rpath);
 480         }
 481
 482       else if (unformat (line_input, "via %U %U weight %u",
 483                          unformat_ip6_address,
 484                          &rpath.frp_addr.ip6,
 485                          unformat_vnet_sw_interface, vnm,
 486                          &rpath.frp_sw_if_index, &rpath.frp_weight))
 487         {
 488           rpath.frp_proto = FIB_PROTOCOL_IP6;
 489           vec_add1 (rpaths, rpath);
 490         }
 491
 492       else if (unformat (line_input, "via %U %U",
 493                          unformat_ip4_address,
 494                          &rpath.frp_addr.ip4,
 495                          unformat_vnet_sw_interface, vnm,
 496                          &rpath.frp_sw_if_index))
 497         {
 498           rpath.frp_weight = 1;
 499           rpath.frp_proto = FIB_PROTOCOL_IP4;
 500           vec_add1 (rpaths, rpath);
 501         }
 502
 503       else if (unformat (line_input, "via %U %U",
 504                          unformat_ip6_address,
 505                          &rpath.frp_addr.ip6,
 506                          unformat_vnet_sw_interface, vnm,
 507                          &rpath.frp_sw_if_index))
 508         {
 509           rpath.frp_weight = 1;
 510           rpath.frp_proto = FIB_PROTOCOL_IP6;
 511           vec_add1 (rpaths, rpath);
 512         }
 513       else if (unformat (line_input, "via %U next-hop-table %d",
 514                          unformat_ip4_address,
 515                          &rpath.frp_addr.ip4, &rpath.frp_fib_index))
 516         {
 517           rpath.frp_weight = 1;
 518           rpath.frp_sw_if_index = ~0;
 519           rpath.frp_proto = FIB_PROTOCOL_IP4;
 520           vec_add1 (rpaths, rpath);
 521         }
 522       else if (unformat (line_input, "via %U next-hop-table %d",
 523                          unformat_ip6_address,
 524                          &rpath.frp_addr.ip6, &rpath.frp_fib_index))
 525         {
 526           rpath.frp_weight = 1;
 527           rpath.frp_sw_if_index = ~0;
 528           rpath.frp_proto = FIB_PROTOCOL_IP6;
 529           vec_add1 (rpaths, rpath);
 530         }
 531       else if (unformat (line_input, "via %U",
 532                          unformat_ip4_address, &rpath.frp_addr.ip4))
 533         {
 534           /*
 535            * the recursive next-hops are by default in the same table
 536            * as the prefix
 537            */
 538           rpath.frp_fib_index = table_id;
 539           rpath.frp_weight = 1;
 540           rpath.frp_sw_if_index = ~0;
 541           rpath.frp_proto = FIB_PROTOCOL_IP4;
 542           vec_add1 (rpaths, rpath);
 543         }
 544       else if (unformat (line_input, "via %U",
 545                          unformat_ip6_address, &rpath.frp_addr.ip6))
 546         {
 547           rpath.frp_fib_index = table_id;
 548           rpath.frp_weight = 1;
 549           rpath.frp_sw_if_index = ~0;
 550           rpath.frp_proto = FIB_PROTOCOL_IP6;
 551           vec_add1 (rpaths, rpath);
 552         }
 553       else if (unformat (line_input,
 554                          "lookup in table %d", &rpath.frp_fib_index))
 555         {
 556           rpath.frp_proto = pfx.fp_proto;
 557           rpath.frp_sw_if_index = ~0;
 558           vec_add1 (rpaths, rpath);
 559         }
 560       else if (vec_len (prefixs) > 0 &&
 561                unformat (line_input, "via %U",
 562                          unformat_vnet_sw_interface, vnm,
 563                          &rpath.frp_sw_if_index))
 564         {
 565           rpath.frp_weight = 1;
 566           rpath.frp_proto = prefixs[0].fp_proto;
 567           vec_add1 (rpaths, rpath);
 568         }
 569       else if (vec_len (prefixs) > 0 &&
 570                unformat (line_input, "via %U",
 571                          unformat_dpo, &dpo, prefixs[0].fp_proto))
 572         {
 573           vec_add1 (dpos, dpo);
 574         }
 575       else
 576         {
 577           error = unformat_parse_error (line_input);
 578           goto done;
 579         }
 580     }
 581
 582   if (vec_len (prefixs) == 0)
 583     {
 584       error =
 585         clib_error_return (0, "expected ip4/ip6 destination address/length.");
 586       goto done;
 587     }
 588
 589   if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
 590     {
 591       error = clib_error_return (0, "expected paths.");
 592       goto done;
 593     }
 594
 595   if (~0 == table_id)
 596     {
 597       /*
 598        * if no table_id is passed we will manipulate the default
 599        */
 600       fib_index = 0;
 601     }
 602   else
 603     {
 604       fib_index = fib_table_id_find_fib_index (prefixs[0].fp_proto, table_id);
 605
 606       if (~0 == fib_index)
 607         {
 608           error = clib_error_return (0, "Nonexistent table id %d", table_id);
 609           goto done;
 610         }
 611     }
 612
 613   for (i = 0; i < vec_len (prefixs); i++)
 614     {
 615       if (is_del && 0 == vec_len (rpaths))
 616         {
 617           fib_table_entry_delete (fib_index, &prefixs[i], FIB_SOURCE_CLI);
 618         }
 619       else if (!is_del && 1 == vec_len (dpos))
 620         {
 621           fib_table_entry_special_dpo_add (fib_index,
 622                                            &prefixs[i],
 623                                            FIB_SOURCE_CLI,
 624                                            FIB_ENTRY_FLAG_EXCLUSIVE,
 625                                            &dpos[0]);
 626           dpo_reset (&dpos[0]);
 627         }
 628       else if (vec_len (dpos) > 0)
 629         {
 630           error =
 631             clib_error_return (0,
 632                                "Load-balancing over multiple special adjacencies is unsupported");
 633           goto done;
 634         }
 635       else if (0 < vec_len (rpaths))
 636         {
 637           u32 k, j, n, incr;
 638           ip46_address_t dst = prefixs[i].fp_addr;
 639           f64 t[2];
 640           n = count;
 641           t[0] = vlib_time_now (vm);
 642           incr = 1 << ((FIB_PROTOCOL_IP4 == prefixs[0].fp_proto ? 32 : 128) -
 643                        prefixs[i].fp_len);
 644
 645           for (k = 0; k < n; k++)
 646             {
 647               for (j = 0; j < vec_len (rpaths); j++)
 648                 {
 649                   u32 fi;
 650                   /*
 651                    * the CLI parsing stored table Ids, swap to FIB indicies
 652                    */
 653                   fi = fib_table_id_find_fib_index (prefixs[i].fp_proto,
 654                                                     rpaths[i].frp_fib_index);
 655
 656                   if (~0 == fi)
 657                     {
 658                       error =
 659                         clib_error_return (0, "Via table %d does not exist",
 660                                            rpaths[i].frp_fib_index);
 661                       goto done;
 662                     }
 663                   rpaths[i].frp_fib_index = fi;
 664
 665                   fib_prefix_t rpfx = {
 666                     .fp_len = prefixs[i].fp_len,
 667                     .fp_proto = prefixs[i].fp_proto,
 668                     .fp_addr = dst,
 669                   };
 670
 671                   if (is_del)
 672                     fib_table_entry_path_remove2 (fib_index,
 673                                                   &rpfx,
 674                                                   FIB_SOURCE_CLI, &rpaths[j]);
 675                   else
 676                     fib_table_entry_path_add2 (fib_index,
 677                                                &rpfx,
 678                                                FIB_SOURCE_CLI,
 679                                                FIB_ENTRY_FLAG_NONE,
 680                                                &rpaths[j]);
 681                 }
 682
 683               if (FIB_PROTOCOL_IP4 == prefixs[0].fp_proto)
 684                 {
 685                   dst.ip4.as_u32 =
 686                     clib_host_to_net_u32 (incr +
 687                                           clib_net_to_host_u32 (dst.
 688                                                                 ip4.as_u32));
 689                 }
 690               else
 691                 {
 692                   int bucket = (incr < 64 ? 0 : 1);
 693                   dst.ip6.as_u64[bucket] =
 694                     clib_host_to_net_u64 (incr +
 695                                           clib_net_to_host_u64 (dst.ip6.as_u64
 696                                                                 [bucket]));
 697
 698                 }
 699             }
 700           t[1] = vlib_time_now (vm);
 701           if (count > 1)
 702             vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
 703         }
 704       else
 705         {
 706           error = clib_error_return (0, "Don't understand what you want...");
 707           goto done;
 708         }
 709     }
 710
 711
 712 done:
 713   vec_free (dpos);
 714   vec_free (prefixs);
 715   vec_free (rpaths);
 716   unformat_free (line_input);
 717   return error;
 718 }
 719
 720 /* *INDENT-OFF* */
 721 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
 722   .path = "ip",
 723   .short_help = "Internet protocol (IP) commands",
 724 };
 725 /* *INDENT-ON* */
 726
 727 /* *INDENT-OFF* */
 728 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
 729   .path = "ip6",
 730   .short_help = "Internet protocol version 6 (IPv6) commands",
 731 };
 732 /* *INDENT-ON* */
 733
 734 /* *INDENT-OFF* */
 735 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
 736   .path = "show ip",
 737   .short_help = "Internet protocol (IP) show commands",
 738 };
 739 /* *INDENT-ON* */
 740
 741 /* *INDENT-OFF* */
 742 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
 743   .path = "show ip6",
 744   .short_help = "Internet protocol version 6 (IPv6) show commands",
 745 };
 746 /* *INDENT-ON* */
 747
 748 /*?
 749  * This command is used to add or delete IPv4 or IPv6 routes. All
 750  * IP Addresses ('<em><dst-ip-addr>/<width></em>',
 751  * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
 752  * can be IPv4 or IPv6, but all must be of the same form in a single
 753  * command. To display the current set of routes, use the commands
 754  * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
 755  *
 756  * @cliexpar
 757  * Example of how to add a straight forward static route:
 758  * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
 759  * Example of how to delete a straight forward static route:
 760  * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
 761  * Mainly for route add/del performance testing, one can add or delete
 762  * multiple routes by adding 'count N' to the previous item:
 763  * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
 764  * Add multiple routes for the same destination to create equal-cost multipath:
 765  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
 766  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
 767  * For unequal-cost multipath, specify the desired weights. This
 768  * combination of weights results in 3/4 of the traffic following the
 769  * second path, 1/4 following the first path:
 770  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
 771  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
 772  * To add a route to a particular FIB table (VRF), use:
 773  * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
 774  ?*/
 775 /* *INDENT-OFF* */
 776 VLIB_CLI_COMMAND (ip_route_command, static) = {
 777   .path = "ip route",
 778   .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>]",
 779   .function = vnet_ip_route_cmd,
 780   .is_mp_safe = 1,
 781 };
 782 /* *INDENT-ON* */
 783
 784 clib_error_t *
 785 vnet_ip_mroute_cmd (vlib_main_t * vm,
 786                     unformat_input_t * main_input, vlib_cli_command_t * cmd)
 787 {
 788   unformat_input_t _line_input, *line_input = &_line_input;
 789   clib_error_t *error = NULL;
 790   fib_route_path_t rpath;
 791   u32 table_id, is_del;
 792   vnet_main_t *vnm;
 793   mfib_prefix_t pfx;
 794   u32 fib_index;
 795   mfib_itf_flags_t iflags = 0;
 796   mfib_entry_flags_t eflags = 0;
 797   u32 gcount, scount, ss, gg, incr;
 798   f64 timet[2];
 799
 800   gcount = scount = 1;
 801   vnm = vnet_get_main ();
 802   is_del = 0;
 803   table_id = 0;
 804   memset (&pfx, 0, sizeof (pfx));
 805   memset (&rpath, 0, sizeof (rpath));
 806   rpath.frp_sw_if_index = ~0;
 807
 808   /* Get a line of input. */
 809   if (!unformat_user (main_input, unformat_line_input, line_input))
 810     return 0;
 811
 812   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 813     {
 814       if (unformat (line_input, "table %d", &table_id))
 815         ;
 816       else if (unformat (line_input, "del"))
 817         is_del = 1;
 818       else if (unformat (line_input, "add"))
 819         is_del = 0;
 820       else if (unformat (line_input, "scount %d", &scount))
 821         ;
 822       else if (unformat (line_input, "gcount %d", &gcount))
 823         ;
 824       else if (unformat (line_input, "%U %U",
 825                          unformat_ip4_address,
 826                          &pfx.fp_src_addr.ip4,
 827                          unformat_ip4_address, &pfx.fp_grp_addr.ip4))
 828         {
 829           pfx.fp_proto = FIB_PROTOCOL_IP4;
 830           pfx.fp_len = 64;
 831         }
 832       else if (unformat (line_input, "%U %U",
 833                          unformat_ip6_address,
 834                          &pfx.fp_src_addr.ip6,
 835                          unformat_ip6_address, &pfx.fp_grp_addr.ip6))
 836         {
 837           pfx.fp_proto = FIB_PROTOCOL_IP6;
 838           pfx.fp_len = 256;
 839         }
 840       else if (unformat (line_input, "%U/%d",
 841                          unformat_ip4_address,
 842                          &pfx.fp_grp_addr.ip4, &pfx.fp_len))
 843         {
 844           pfx.fp_proto = FIB_PROTOCOL_IP4;
 845         }
 846       else if (unformat (line_input, "%U/%d",
 847                          unformat_ip6_address,
 848                          &pfx.fp_grp_addr.ip6, &pfx.fp_len))
 849         {
 850           pfx.fp_proto = FIB_PROTOCOL_IP6;
 851         }
 852       else if (unformat (line_input, "%U",
 853                          unformat_ip4_address, &pfx.fp_grp_addr.ip4))
 854         {
 855           memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
 856           pfx.fp_proto = FIB_PROTOCOL_IP4;
 857           pfx.fp_len = 32;
 858         }
 859       else if (unformat (line_input, "%U",
 860                          unformat_ip6_address, &pfx.fp_grp_addr.ip6))
 861         {
 862           memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
 863           pfx.fp_proto = FIB_PROTOCOL_IP6;
 864           pfx.fp_len = 128;
 865         }
 866       else if (unformat (line_input, "via %U",
 867                          unformat_vnet_sw_interface, vnm,
 868                          &rpath.frp_sw_if_index))
 869         {
 870           rpath.frp_weight = 1;
 871           rpath.frp_proto = FIB_PROTOCOL_IP4;
 872         }
 873       else if (unformat (line_input, "%U", unformat_mfib_itf_flags, &iflags))
 874         ;
 875       else if (unformat (line_input, "%U",
 876                          unformat_mfib_entry_flags, &eflags))
 877         ;
 878       else
 879         {
 880           error = unformat_parse_error (line_input);
 881           goto done;
 882         }
 883     }
 884
 885   if (~0 == table_id)
 886     {
 887       /*
 888        * if no table_id is passed we will manipulate the default
 889        */
 890       fib_index = 0;
 891     }
 892   else
 893     {
 894       fib_index = mfib_table_find (pfx.fp_proto, table_id);
 895
 896       if (~0 == fib_index)
 897         {
 898           error = clib_error_return (0, "Nonexistent table id %d", table_id);
 899           goto done;
 900         }
 901     }
 902
 903   timet[0] = vlib_time_now (vm);
 904
 905   if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
 906     {
 907       incr = 1 << (32 - (pfx.fp_len % 32));
 908     }
 909   else
 910     {
 911       incr = 1 << (128 - (pfx.fp_len % 128));
 912     }
 913
 914   for (ss = 0; ss < scount; ss++)
 915     {
 916       for (gg = 0; gg < gcount; gg++)
 917         {
 918           if (is_del && 0 == rpath.frp_weight)
 919             {
 920               /* no path provided => route delete */
 921               mfib_table_entry_delete (fib_index, &pfx, MFIB_SOURCE_CLI);
 922             }
 923           else if (eflags)
 924             {
 925               mfib_table_entry_update (fib_index, &pfx, MFIB_SOURCE_CLI,
 926                                        eflags);
 927             }
 928           else
 929             {
 930               if (is_del)
 931                 mfib_table_entry_path_remove (fib_index,
 932                                               &pfx, MFIB_SOURCE_CLI, &rpath);
 933               else
 934                 mfib_table_entry_path_update (fib_index,
 935                                               &pfx, MFIB_SOURCE_CLI, &rpath,
 936                                               iflags);
 937             }
 938
 939           if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
 940             {
 941               pfx.fp_grp_addr.ip4.as_u32 =
 942                 clib_host_to_net_u32 (incr +
 943                                       clib_net_to_host_u32 (pfx.
 944                                                             fp_grp_addr.ip4.
 945                                                             as_u32));
 946             }
 947           else
 948             {
 949               int bucket = (incr < 64 ? 0 : 1);
 950               pfx.fp_grp_addr.ip6.as_u64[bucket] =
 951                 clib_host_to_net_u64 (incr +
 952                                       clib_net_to_host_u64 (pfx.
 953                                                             fp_grp_addr.ip6.as_u64
 954                                                             [bucket]));
 955
 956             }
 957         }
 958       if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
 959         {
 960           pfx.fp_src_addr.ip4.as_u32 =
 961             clib_host_to_net_u32 (1 +
 962                                   clib_net_to_host_u32 (pfx.fp_src_addr.
 963                                                         ip4.as_u32));
 964         }
 965       else
 966         {
 967           pfx.fp_src_addr.ip6.as_u64[1] =
 968             clib_host_to_net_u64 (1 +
 969                                   clib_net_to_host_u64 (pfx.fp_src_addr.
 970                                                         ip6.as_u64[1]));
 971         }
 972     }
 973
 974   timet[1] = vlib_time_now (vm);
 975
 976   if (scount > 1 || gcount > 1)
 977     vlib_cli_output (vm, "%.6e routes/sec",
 978                      (scount * gcount) / (timet[1] - timet[0]));
 979
 980 done:
 981   unformat_free (line_input);
 982
 983   return error;
 984 }
 985
 986 /*?
 987  * This command is used to add or delete IPv4 or IPv6  multicastroutes. All
 988  * IP Addresses ('<em><dst-ip-addr>/<width></em>',
 989  * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
 990  * can be IPv4 or IPv6, but all must be of the same form in a single
 991  * command. To display the current set of routes, use the commands
 992  * '<em>show ip mfib</em>' and '<em>show ip6 mfib</em>'.
 993  * The full set of support flags for interfaces and route is shown via;
 994  * '<em>show mfib route flags</em>' and '<em>show mfib itf flags</em>'
 995  * respectively.
 996  * @cliexpar
 997  * Example of how to add a forwarding interface to a route (and create the
 998  * route if it does not exist)
 999  * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/0 Forward}
1000  * Example of how to add an accepting interface to a route (and create the
1001  * route if it does not exist)
1002  * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/1 Accept}
1003  * Example of changing the route's flags to send signals via the API
1004  * @cliexcmd{ip mroute add 232.1.1.1 Signal}
1005
1006  ?*/
1007 /* *INDENT-OFF* */
1008 VLIB_CLI_COMMAND (ip_mroute_command, static) =
1009 {
1010   .path = "ip mroute",
1011   .short_help = "ip mroute [add|del] <dst-ip-addr>/<width> [table <table-id>] [via <next-hop-ip-addr> [<interface>],",
1012   .function = vnet_ip_mroute_cmd,
1013   .is_mp_safe = 1,
1014 };
1015 /* *INDENT-ON* */
1016
1017 /*
1018  * The next two routines address a longstanding script hemorrhoid.
1019  * Probing a v4 or v6 neighbor needs to appear to be synchronous,
1020  * or dependent route-adds will simply fail.
1021  */
1022 static clib_error_t *
1023 ip6_probe_neighbor_wait (vlib_main_t * vm, ip6_address_t * a, u32 sw_if_index,
1024                          int retry_count)
1025 {
1026   vnet_main_t *vnm = vnet_get_main ();
1027   clib_error_t *e;
1028   int i;
1029   int resolved = 0;
1030   uword event_type;
1031   uword *event_data = 0;
1032
1033   ASSERT (vlib_in_process_context (vm));
1034
1035   if (retry_count > 0)
1036     vnet_register_ip6_neighbor_resolution_event
1037       (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1038        1 /* event */ , 0 /* data */ );
1039
1040   for (i = 0; i < retry_count; i++)
1041     {
1042       /* The interface may be down, etc. */
1043       e = ip6_probe_neighbor (vm, a, sw_if_index);
1044
1045       if (e)
1046         return e;
1047
1048       vlib_process_wait_for_event_or_clock (vm, 1.0);
1049       event_type = vlib_process_get_events (vm, &event_data);
1050       switch (event_type)
1051         {
1052         case 1:         /* resolved... */
1053           vlib_cli_output (vm, "Resolved %U", format_ip6_address, a);
1054           resolved = 1;
1055           goto done;
1056
1057         case ~0:                /* timeout */
1058           break;
1059
1060         default:
1061           clib_warning ("unknown event_type %d", event_type);
1062         }
1063       vec_reset_length (event_data);
1064     }
1065
1066 done:
1067
1068   if (!resolved)
1069     return clib_error_return (0, "Resolution failed for %U",
1070                               format_ip6_address, a);
1071   return 0;
1072 }
1073
1074 static clib_error_t *
1075 ip4_probe_neighbor_wait (vlib_main_t * vm, ip4_address_t * a, u32 sw_if_index,
1076                          int retry_count)
1077 {
1078   vnet_main_t *vnm = vnet_get_main ();
1079   clib_error_t *e;
1080   int i;
1081   int resolved = 0;
1082   uword event_type;
1083   uword *event_data = 0;
1084
1085   ASSERT (vlib_in_process_context (vm));
1086
1087   if (retry_count > 0)
1088     vnet_register_ip4_arp_resolution_event
1089       (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1090        1 /* event */ , 0 /* data */ );
1091
1092   for (i = 0; i < retry_count; i++)
1093     {
1094       /* The interface may be down, etc. */
1095       e = ip4_probe_neighbor (vm, a, sw_if_index);
1096
1097       if (e)
1098         return e;
1099
1100       vlib_process_wait_for_event_or_clock (vm, 1.0);
1101       event_type = vlib_process_get_events (vm, &event_data);
1102       switch (event_type)
1103         {
1104         case 1:         /* resolved... */
1105           vlib_cli_output (vm, "Resolved %U", format_ip4_address, a);
1106           resolved = 1;
1107           goto done;
1108
1109         case ~0:                /* timeout */
1110           break;
1111
1112         default:
1113           clib_warning ("unknown event_type %d", event_type);
1114         }
1115       vec_reset_length (event_data);
1116     }
1117
1118 done:
1119
1120   vec_reset_length (event_data);
1121
1122   if (!resolved)
1123     return clib_error_return (0, "Resolution failed for %U",
1124                               format_ip4_address, a);
1125   return 0;
1126 }
1127
1128 static clib_error_t *
1129 probe_neighbor_address (vlib_main_t * vm,
1130                         unformat_input_t * input, vlib_cli_command_t * cmd)
1131 {
1132   vnet_main_t *vnm = vnet_get_main ();
1133   unformat_input_t _line_input, *line_input = &_line_input;
1134   ip4_address_t a4;
1135   ip6_address_t a6;
1136   clib_error_t *error = 0;
1137   u32 sw_if_index = ~0;
1138   int retry_count = 3;
1139   int is_ip4 = 1;
1140   int address_set = 0;
1141
1142   /* Get a line of input. */
1143   if (!unformat_user (input, unformat_line_input, line_input))
1144     return 0;
1145
1146   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1147     {
1148       if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
1149                          &sw_if_index))
1150         ;
1151       else if (unformat (line_input, "retry %d", &retry_count))
1152         ;
1153
1154       else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
1155         address_set++;
1156       else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
1157         {
1158           address_set++;
1159           is_ip4 = 0;
1160         }
1161       else
1162         {
1163           error = clib_error_return (0, "unknown input '%U'",
1164                                      format_unformat_error, line_input);
1165           goto done;
1166         }
1167     }
1168
1169   if (sw_if_index == ~0)
1170     {
1171       error = clib_error_return (0, "Interface required, not set.");
1172       goto done;
1173     }
1174   if (address_set == 0)
1175     {
1176       error = clib_error_return (0, "ip address required, not set.");
1177       goto done;
1178     }
1179   if (address_set > 1)
1180     {
1181       error = clib_error_return (0, "Multiple ip addresses not supported.");
1182       goto done;
1183     }
1184
1185   if (is_ip4)
1186     error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
1187   else
1188     error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
1189
1190 done:
1191   unformat_free (line_input);
1192
1193   return error;
1194 }
1195
1196 /*?
1197  * The '<em>ip probe-neighbor</em>' command ARPs for IPv4 addresses or
1198  * attempts IPv6 neighbor discovery depending on the supplied IP address
1199  * format.
1200  *
1201  * @note This command will not immediately affect the indicated FIB; it
1202  * is not suitable for use in establishing a FIB entry prior to adding
1203  * recursive FIB entries. As in: don't use it in a script to probe a
1204  * gateway prior to adding a default route. It won't work. Instead,
1205  * configure a static ARP cache entry [see '<em>set ip arp</em>'], or
1206  * a static IPv6 neighbor [see '<em>set ip6 neighbor</em>'].
1207  *
1208  * @cliexpar
1209  * Example of probe for an IPv4 address:
1210  * @cliexcmd{ip probe-neighbor GigabitEthernet2/0/0 172.16.1.2}
1211 ?*/
1212 /* *INDENT-OFF* */
1213 VLIB_CLI_COMMAND (ip_probe_neighbor_command, static) = {
1214   .path = "ip probe-neighbor",
1215   .function = probe_neighbor_address,
1216   .short_help = "ip probe-neighbor <interface> <ip4-addr> | <ip6-addr> [retry nn]",
1217   .is_mp_safe = 1,
1218 };
1219 /* *INDENT-ON* */
1220
1221 /*
1222  * fd.io coding-style-patch-verification: ON
1223  *
1224  * Local Variables:
1225  * eval: (c-set-style "gnu")
1226  * End:
1227  */