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