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_eos = MPLS_NON_EOS;
 454           rpath.frp_proto = FIB_PROTOCOL_MPLS;
 455           rpath.frp_sw_if_index = ~0;
 456           vec_add1 (rpaths, rpath);
 457         }
 458       else if (unformat (line_input, "count %f", &count))
 459         ;
 460
 461       else if (unformat (line_input, "%U/%d",
 462                          unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
 463         {
 464           pfx.fp_proto = FIB_PROTOCOL_IP4;
 465           vec_add1 (prefixs, pfx);
 466         }
 467       else if (unformat (line_input, "%U/%d",
 468                          unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
 469         {
 470           pfx.fp_proto = FIB_PROTOCOL_IP6;
 471           vec_add1 (prefixs, pfx);
 472         }
 473       else if (unformat (line_input, "via %U %U weight %u",
 474                          unformat_ip4_address,
 475                          &rpath.frp_addr.ip4,
 476                          unformat_vnet_sw_interface, vnm,
 477                          &rpath.frp_sw_if_index, &rpath.frp_weight))
 478         {
 479           rpath.frp_proto = FIB_PROTOCOL_IP4;
 480           vec_add1 (rpaths, rpath);
 481         }
 482
 483       else if (unformat (line_input, "via %U %U weight %u",
 484                          unformat_ip6_address,
 485                          &rpath.frp_addr.ip6,
 486                          unformat_vnet_sw_interface, vnm,
 487                          &rpath.frp_sw_if_index, &rpath.frp_weight))
 488         {
 489           rpath.frp_proto = FIB_PROTOCOL_IP6;
 490           vec_add1 (rpaths, rpath);
 491         }
 492
 493       else if (unformat (line_input, "via %U %U",
 494                          unformat_ip4_address,
 495                          &rpath.frp_addr.ip4,
 496                          unformat_vnet_sw_interface, vnm,
 497                          &rpath.frp_sw_if_index))
 498         {
 499           rpath.frp_weight = 1;
 500           rpath.frp_proto = FIB_PROTOCOL_IP4;
 501           vec_add1 (rpaths, rpath);
 502         }
 503
 504       else if (unformat (line_input, "via %U %U",
 505                          unformat_ip6_address,
 506                          &rpath.frp_addr.ip6,
 507                          unformat_vnet_sw_interface, vnm,
 508                          &rpath.frp_sw_if_index))
 509         {
 510           rpath.frp_weight = 1;
 511           rpath.frp_proto = FIB_PROTOCOL_IP6;
 512           vec_add1 (rpaths, rpath);
 513         }
 514       else if (unformat (line_input, "via %U next-hop-table %d",
 515                          unformat_ip4_address,
 516                          &rpath.frp_addr.ip4, &rpath.frp_fib_index))
 517         {
 518           rpath.frp_weight = 1;
 519           rpath.frp_sw_if_index = ~0;
 520           rpath.frp_proto = FIB_PROTOCOL_IP4;
 521           vec_add1 (rpaths, rpath);
 522         }
 523       else if (unformat (line_input, "via %U next-hop-table %d",
 524                          unformat_ip6_address,
 525                          &rpath.frp_addr.ip6, &rpath.frp_fib_index))
 526         {
 527           rpath.frp_weight = 1;
 528           rpath.frp_sw_if_index = ~0;
 529           rpath.frp_proto = FIB_PROTOCOL_IP6;
 530           vec_add1 (rpaths, rpath);
 531         }
 532       else if (unformat (line_input, "via %U",
 533                          unformat_ip4_address, &rpath.frp_addr.ip4))
 534         {
 535           /*
 536            * the recursive next-hops are by default in the same table
 537            * as the prefix
 538            */
 539           rpath.frp_fib_index = table_id;
 540           rpath.frp_weight = 1;
 541           rpath.frp_sw_if_index = ~0;
 542           rpath.frp_proto = FIB_PROTOCOL_IP4;
 543           vec_add1 (rpaths, rpath);
 544         }
 545       else if (unformat (line_input, "via %U",
 546                          unformat_ip6_address, &rpath.frp_addr.ip6))
 547         {
 548           rpath.frp_fib_index = table_id;
 549           rpath.frp_weight = 1;
 550           rpath.frp_sw_if_index = ~0;
 551           rpath.frp_proto = FIB_PROTOCOL_IP6;
 552           vec_add1 (rpaths, rpath);
 553         }
 554       else if (unformat (line_input,
 555                          "lookup in table %d", &rpath.frp_fib_index))
 556         {
 557           rpath.frp_proto = pfx.fp_proto;
 558           rpath.frp_sw_if_index = ~0;
 559           vec_add1 (rpaths, rpath);
 560         }
 561       else if (vec_len (prefixs) > 0 &&
 562                unformat (line_input, "via %U",
 563                          unformat_vnet_sw_interface, vnm,
 564                          &rpath.frp_sw_if_index))
 565         {
 566           rpath.frp_weight = 1;
 567           rpath.frp_proto = prefixs[0].fp_proto;
 568           vec_add1 (rpaths, rpath);
 569         }
 570       else if (vec_len (prefixs) > 0 &&
 571                unformat (line_input, "via %U",
 572                          unformat_dpo, &dpo, prefixs[0].fp_proto))
 573         {
 574           vec_add1 (dpos, dpo);
 575         }
 576       else
 577         {
 578           error = unformat_parse_error (line_input);
 579           goto done;
 580         }
 581     }
 582
 583   if (vec_len (prefixs) == 0)
 584     {
 585       error =
 586         clib_error_return (0, "expected ip4/ip6 destination address/length.");
 587       goto done;
 588     }
 589
 590   if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
 591     {
 592       error = clib_error_return (0, "expected paths.");
 593       goto done;
 594     }
 595
 596   if (~0 == table_id)
 597     {
 598       /*
 599        * if no table_id is passed we will manipulate the default
 600        */
 601       fib_index = 0;
 602     }
 603   else
 604     {
 605       fib_index = fib_table_id_find_fib_index (prefixs[0].fp_proto, table_id);
 606
 607       if (~0 == fib_index)
 608         {
 609           error = clib_error_return (0, "Nonexistent table id %d", table_id);
 610           goto done;
 611         }
 612     }
 613
 614   for (i = 0; i < vec_len (prefixs); i++)
 615     {
 616       if (is_del && 0 == vec_len (rpaths))
 617         {
 618           fib_table_entry_delete (fib_index, &prefixs[i], FIB_SOURCE_CLI);
 619         }
 620       else if (!is_del && 1 == vec_len (dpos))
 621         {
 622           fib_table_entry_special_dpo_add (fib_index,
 623                                            &prefixs[i],
 624                                            FIB_SOURCE_CLI,
 625                                            FIB_ENTRY_FLAG_EXCLUSIVE,
 626                                            &dpos[0]);
 627           dpo_reset (&dpos[0]);
 628         }
 629       else if (vec_len (dpos) > 0)
 630         {
 631           error =
 632             clib_error_return (0,
 633                                "Load-balancing over multiple special adjacencies is unsupported");
 634           goto done;
 635         }
 636       else if (0 < vec_len (rpaths))
 637         {
 638           u32 k, j, n, incr;
 639           ip46_address_t dst = prefixs[i].fp_addr;
 640           f64 t[2];
 641           n = count;
 642           t[0] = vlib_time_now (vm);
 643           incr = 1 << ((FIB_PROTOCOL_IP4 == prefixs[0].fp_proto ? 32 : 128) -
 644                        prefixs[i].fp_len);
 645
 646           for (k = 0; k < n; k++)
 647             {
 648               for (j = 0; j < vec_len (rpaths); j++)
 649                 {
 650                   u32 fi;
 651                   /*
 652                    * the CLI parsing stored table Ids, swap to FIB indicies
 653                    */
 654                   fi = fib_table_id_find_fib_index (prefixs[i].fp_proto,
 655                                                     rpaths[i].frp_fib_index);
 656
 657                   if (~0 == fi)
 658                     {
 659                       error =
 660                         clib_error_return (0, "Via table %d does not exist",
 661                                            rpaths[i].frp_fib_index);
 662                       goto done;
 663                     }
 664                   rpaths[i].frp_fib_index = fi;
 665
 666                   fib_prefix_t rpfx = {
 667                     .fp_len = prefixs[i].fp_len,
 668                     .fp_proto = prefixs[i].fp_proto,
 669                     .fp_addr = dst,
 670                   };
 671
 672                   if (is_del)
 673                     fib_table_entry_path_remove2 (fib_index,
 674                                                   &rpfx,
 675                                                   FIB_SOURCE_CLI, &rpaths[j]);
 676                   else
 677                     fib_table_entry_path_add2 (fib_index,
 678                                                &rpfx,
 679                                                FIB_SOURCE_CLI,
 680                                                FIB_ENTRY_FLAG_NONE,
 681                                                &rpaths[j]);
 682                 }
 683
 684               if (FIB_PROTOCOL_IP4 == prefixs[0].fp_proto)
 685                 {
 686                   dst.ip4.as_u32 =
 687                     clib_host_to_net_u32 (incr +
 688                                           clib_net_to_host_u32 (dst.
 689                                                                 ip4.as_u32));
 690                 }
 691               else
 692                 {
 693                   int bucket = (incr < 64 ? 0 : 1);
 694                   dst.ip6.as_u64[bucket] =
 695                     clib_host_to_net_u64 (incr +
 696                                           clib_net_to_host_u64 (dst.ip6.as_u64
 697                                                                 [bucket]));
 698
 699                 }
 700             }
 701           t[1] = vlib_time_now (vm);
 702           if (count > 1)
 703             vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
 704         }
 705       else
 706         {
 707           error = clib_error_return (0, "Don't understand what you want...");
 708           goto done;
 709         }
 710     }
 711
 712
 713 done:
 714   vec_free (dpos);
 715   vec_free (prefixs);
 716   vec_free (rpaths);
 717   unformat_free (line_input);
 718   return error;
 719 }
 720
 721 /* *INDENT-OFF* */
 722 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
 723   .path = "ip",
 724   .short_help = "Internet protocol (IP) commands",
 725 };
 726 /* *INDENT-ON* */
 727
 728 /* *INDENT-OFF* */
 729 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
 730   .path = "ip6",
 731   .short_help = "Internet protocol version 6 (IPv6) commands",
 732 };
 733 /* *INDENT-ON* */
 734
 735 /* *INDENT-OFF* */
 736 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
 737   .path = "show ip",
 738   .short_help = "Internet protocol (IP) show commands",
 739 };
 740 /* *INDENT-ON* */
 741
 742 /* *INDENT-OFF* */
 743 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
 744   .path = "show ip6",
 745   .short_help = "Internet protocol version 6 (IPv6) show commands",
 746 };
 747 /* *INDENT-ON* */
 748
 749 /*?
 750  * This command is used to add or delete IPv4 or IPv6 routes. All
 751  * IP Addresses ('<em><dst-ip-addr>/<width></em>',
 752  * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
 753  * can be IPv4 or IPv6, but all must be of the same form in a single
 754  * command. To display the current set of routes, use the commands
 755  * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
 756  *
 757  * @cliexpar
 758  * Example of how to add a straight forward static route:
 759  * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
 760  * Example of how to delete a straight forward static route:
 761  * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
 762  * Mainly for route add/del performance testing, one can add or delete
 763  * multiple routes by adding 'count N' to the previous item:
 764  * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
 765  * Add multiple routes for the same destination to create equal-cost multipath:
 766  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
 767  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
 768  * For unequal-cost multipath, specify the desired weights. This
 769  * combination of weights results in 3/4 of the traffic following the
 770  * second path, 1/4 following the first path:
 771  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
 772  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
 773  * To add a route to a particular FIB table (VRF), use:
 774  * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
 775  ?*/
 776 /* *INDENT-OFF* */
 777 VLIB_CLI_COMMAND (ip_route_command, static) = {
 778   .path = "ip route",
 779   .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>]",
 780   .function = vnet_ip_route_cmd,
 781   .is_mp_safe = 1,
 782 };
 783 /* *INDENT-ON* */
 784
 785 clib_error_t *
 786 vnet_ip_mroute_cmd (vlib_main_t * vm,
 787                     unformat_input_t * main_input, vlib_cli_command_t * cmd)
 788 {
 789   unformat_input_t _line_input, *line_input = &_line_input;
 790   clib_error_t *error = NULL;
 791   fib_route_path_t rpath;
 792   u32 table_id, is_del;
 793   vnet_main_t *vnm;
 794   mfib_prefix_t pfx;
 795   u32 fib_index;
 796   mfib_itf_flags_t iflags = 0;
 797   mfib_entry_flags_t eflags = 0;
 798   u32 gcount, scount, ss, gg, incr;
 799   f64 timet[2];
 800
 801   gcount = scount = 1;
 802   vnm = vnet_get_main ();
 803   is_del = 0;
 804   table_id = 0;
 805   memset (&pfx, 0, sizeof (pfx));
 806   memset (&rpath, 0, sizeof (rpath));
 807   rpath.frp_sw_if_index = ~0;
 808
 809   /* Get a line of input. */
 810   if (!unformat_user (main_input, unformat_line_input, line_input))
 811     return 0;
 812
 813   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 814     {
 815       if (unformat (line_input, "table %d", &table_id))
 816         ;
 817       else if (unformat (line_input, "del"))
 818         is_del = 1;
 819       else if (unformat (line_input, "add"))
 820         is_del = 0;
 821       else if (unformat (line_input, "scount %d", &scount))
 822         ;
 823       else if (unformat (line_input, "gcount %d", &gcount))
 824         ;
 825       else if (unformat (line_input, "%U %U",
 826                          unformat_ip4_address,
 827                          &pfx.fp_src_addr.ip4,
 828                          unformat_ip4_address, &pfx.fp_grp_addr.ip4))
 829         {
 830           pfx.fp_proto = FIB_PROTOCOL_IP4;
 831           pfx.fp_len = 64;
 832         }
 833       else if (unformat (line_input, "%U %U",
 834                          unformat_ip6_address,
 835                          &pfx.fp_src_addr.ip6,
 836                          unformat_ip6_address, &pfx.fp_grp_addr.ip6))
 837         {
 838           pfx.fp_proto = FIB_PROTOCOL_IP6;
 839           pfx.fp_len = 256;
 840         }
 841       else if (unformat (line_input, "%U/%d",
 842                          unformat_ip4_address,
 843                          &pfx.fp_grp_addr.ip4, &pfx.fp_len))
 844         {
 845           pfx.fp_proto = FIB_PROTOCOL_IP4;
 846         }
 847       else if (unformat (line_input, "%U/%d",
 848                          unformat_ip6_address,
 849                          &pfx.fp_grp_addr.ip6, &pfx.fp_len))
 850         {
 851           pfx.fp_proto = FIB_PROTOCOL_IP6;
 852         }
 853       else if (unformat (line_input, "%U",
 854                          unformat_ip4_address, &pfx.fp_grp_addr.ip4))
 855         {
 856           memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
 857           pfx.fp_proto = FIB_PROTOCOL_IP4;
 858           pfx.fp_len = 32;
 859         }
 860       else if (unformat (line_input, "%U",
 861                          unformat_ip6_address, &pfx.fp_grp_addr.ip6))
 862         {
 863           memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
 864           pfx.fp_proto = FIB_PROTOCOL_IP6;
 865           pfx.fp_len = 128;
 866         }
 867       else if (unformat (line_input, "via %U",
 868                          unformat_vnet_sw_interface, vnm,
 869                          &rpath.frp_sw_if_index))
 870         {
 871           rpath.frp_weight = 1;
 872           rpath.frp_proto = FIB_PROTOCOL_IP4;
 873         }
 874       else if (unformat (line_input, "%U", unformat_mfib_itf_flags, &iflags))
 875         ;
 876       else if (unformat (line_input, "%U",
 877                          unformat_mfib_entry_flags, &eflags))
 878         ;
 879       else
 880         {
 881           error = unformat_parse_error (line_input);
 882           goto done;
 883         }
 884     }
 885
 886   if (~0 == table_id)
 887     {
 888       /*
 889        * if no table_id is passed we will manipulate the default
 890        */
 891       fib_index = 0;
 892     }
 893   else
 894     {
 895       fib_index = mfib_table_find (pfx.fp_proto, table_id);
 896
 897       if (~0 == fib_index)
 898         {
 899           error = clib_error_return (0, "Nonexistent table id %d", table_id);
 900           goto done;
 901         }
 902     }
 903
 904   timet[0] = vlib_time_now (vm);
 905
 906   if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
 907     {
 908       incr = 1 << (32 - (pfx.fp_len % 32));
 909     }
 910   else
 911     {
 912       incr = 1 << (128 - (pfx.fp_len % 128));
 913     }
 914
 915   for (ss = 0; ss < scount; ss++)
 916     {
 917       for (gg = 0; gg < gcount; gg++)
 918         {
 919           if (is_del && 0 == rpath.frp_weight)
 920             {
 921               /* no path provided => route delete */
 922               mfib_table_entry_delete (fib_index, &pfx, MFIB_SOURCE_CLI);
 923             }
 924           else if (eflags)
 925             {
 926               mfib_table_entry_update (fib_index, &pfx, MFIB_SOURCE_CLI,
 927                                        MFIB_RPF_ID_NONE, eflags);
 928             }
 929           else
 930             {
 931               if (is_del)
 932                 mfib_table_entry_path_remove (fib_index,
 933                                               &pfx, MFIB_SOURCE_CLI, &rpath);
 934               else
 935                 mfib_table_entry_path_update (fib_index,
 936                                               &pfx, MFIB_SOURCE_CLI, &rpath,
 937                                               iflags);
 938             }
 939
 940           if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
 941             {
 942               pfx.fp_grp_addr.ip4.as_u32 =
 943                 clib_host_to_net_u32 (incr +
 944                                       clib_net_to_host_u32 (pfx.
 945                                                             fp_grp_addr.ip4.
 946                                                             as_u32));
 947             }
 948           else
 949             {
 950               int bucket = (incr < 64 ? 0 : 1);
 951               pfx.fp_grp_addr.ip6.as_u64[bucket] =
 952                 clib_host_to_net_u64 (incr +
 953                                       clib_net_to_host_u64 (pfx.
 954                                                             fp_grp_addr.ip6.as_u64
 955                                                             [bucket]));
 956
 957             }
 958         }
 959       if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
 960         {
 961           pfx.fp_src_addr.ip4.as_u32 =
 962             clib_host_to_net_u32 (1 +
 963                                   clib_net_to_host_u32 (pfx.fp_src_addr.
 964                                                         ip4.as_u32));
 965         }
 966       else
 967         {
 968           pfx.fp_src_addr.ip6.as_u64[1] =
 969             clib_host_to_net_u64 (1 +
 970                                   clib_net_to_host_u64 (pfx.fp_src_addr.
 971                                                         ip6.as_u64[1]));
 972         }
 973     }
 974
 975   timet[1] = vlib_time_now (vm);
 976
 977   if (scount > 1 || gcount > 1)
 978     vlib_cli_output (vm, "%.6e routes/sec",
 979                      (scount * gcount) / (timet[1] - timet[0]));
 980
 981 done:
 982   unformat_free (line_input);
 983
 984   return error;
 985 }
 986
 987 /*?
 988  * This command is used to add or delete IPv4 or IPv6  multicastroutes. All
 989  * IP Addresses ('<em><dst-ip-addr>/<width></em>',
 990  * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
 991  * can be IPv4 or IPv6, but all must be of the same form in a single
 992  * command. To display the current set of routes, use the commands
 993  * '<em>show ip mfib</em>' and '<em>show ip6 mfib</em>'.
 994  * The full set of support flags for interfaces and route is shown via;
 995  * '<em>show mfib route flags</em>' and '<em>show mfib itf flags</em>'
 996  * respectively.
 997  * @cliexpar
 998  * Example of how to add a forwarding interface to a route (and create the
 999  * route if it does not exist)
1000  * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/0 Forward}
1001  * Example of how to add an accepting interface to a route (and create the
1002  * route if it does not exist)
1003  * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/1 Accept}
1004  * Example of changing the route's flags to send signals via the API
1005  * @cliexcmd{ip mroute add 232.1.1.1 Signal}
1006
1007  ?*/
1008 /* *INDENT-OFF* */
1009 VLIB_CLI_COMMAND (ip_mroute_command, static) =
1010 {
1011   .path = "ip mroute",
1012   .short_help = "ip mroute [add|del] <dst-ip-addr>/<width> [table <table-id>] [via <next-hop-ip-addr> [<interface>],",
1013   .function = vnet_ip_mroute_cmd,
1014   .is_mp_safe = 1,
1015 };
1016 /* *INDENT-ON* */
1017
1018 /*
1019  * The next two routines address a longstanding script hemorrhoid.
1020  * Probing a v4 or v6 neighbor needs to appear to be synchronous,
1021  * or dependent route-adds will simply fail.
1022  */
1023 static clib_error_t *
1024 ip6_probe_neighbor_wait (vlib_main_t * vm, ip6_address_t * a, u32 sw_if_index,
1025                          int retry_count)
1026 {
1027   vnet_main_t *vnm = vnet_get_main ();
1028   clib_error_t *e;
1029   int i;
1030   int resolved = 0;
1031   uword event_type;
1032   uword *event_data = 0;
1033
1034   ASSERT (vlib_in_process_context (vm));
1035
1036   if (retry_count > 0)
1037     vnet_register_ip6_neighbor_resolution_event
1038       (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1039        1 /* event */ , 0 /* data */ );
1040
1041   for (i = 0; i < retry_count; i++)
1042     {
1043       /* The interface may be down, etc. */
1044       e = ip6_probe_neighbor (vm, a, sw_if_index);
1045
1046       if (e)
1047         return e;
1048
1049       vlib_process_wait_for_event_or_clock (vm, 1.0);
1050       event_type = vlib_process_get_events (vm, &event_data);
1051       switch (event_type)
1052         {
1053         case 1:         /* resolved... */
1054           vlib_cli_output (vm, "Resolved %U", format_ip6_address, a);
1055           resolved = 1;
1056           goto done;
1057
1058         case ~0:                /* timeout */
1059           break;
1060
1061         default:
1062           clib_warning ("unknown event_type %d", event_type);
1063         }
1064       vec_reset_length (event_data);
1065     }
1066
1067 done:
1068
1069   if (!resolved)
1070     return clib_error_return (0, "Resolution failed for %U",
1071                               format_ip6_address, a);
1072   return 0;
1073 }
1074
1075 static clib_error_t *
1076 ip4_probe_neighbor_wait (vlib_main_t * vm, ip4_address_t * a, u32 sw_if_index,
1077                          int retry_count)
1078 {
1079   vnet_main_t *vnm = vnet_get_main ();
1080   clib_error_t *e;
1081   int i;
1082   int resolved = 0;
1083   uword event_type;
1084   uword *event_data = 0;
1085
1086   ASSERT (vlib_in_process_context (vm));
1087
1088   if (retry_count > 0)
1089     vnet_register_ip4_arp_resolution_event
1090       (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1091        1 /* event */ , 0 /* data */ );
1092
1093   for (i = 0; i < retry_count; i++)
1094     {
1095       /* The interface may be down, etc. */
1096       e = ip4_probe_neighbor (vm, a, sw_if_index);
1097
1098       if (e)
1099         return e;
1100
1101       vlib_process_wait_for_event_or_clock (vm, 1.0);
1102       event_type = vlib_process_get_events (vm, &event_data);
1103       switch (event_type)
1104         {
1105         case 1:         /* resolved... */
1106           vlib_cli_output (vm, "Resolved %U", format_ip4_address, a);
1107           resolved = 1;
1108           goto done;
1109
1110         case ~0:                /* timeout */
1111           break;
1112
1113         default:
1114           clib_warning ("unknown event_type %d", event_type);
1115         }
1116       vec_reset_length (event_data);
1117     }
1118
1119 done:
1120
1121   vec_reset_length (event_data);
1122
1123   if (!resolved)
1124     return clib_error_return (0, "Resolution failed for %U",
1125                               format_ip4_address, a);
1126   return 0;
1127 }
1128
1129 static clib_error_t *
1130 probe_neighbor_address (vlib_main_t * vm,
1131                         unformat_input_t * input, vlib_cli_command_t * cmd)
1132 {
1133   vnet_main_t *vnm = vnet_get_main ();
1134   unformat_input_t _line_input, *line_input = &_line_input;
1135   ip4_address_t a4;
1136   ip6_address_t a6;
1137   clib_error_t *error = 0;
1138   u32 sw_if_index = ~0;
1139   int retry_count = 3;
1140   int is_ip4 = 1;
1141   int address_set = 0;
1142
1143   /* Get a line of input. */
1144   if (!unformat_user (input, unformat_line_input, line_input))
1145     return 0;
1146
1147   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1148     {
1149       if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
1150                          &sw_if_index))
1151         ;
1152       else if (unformat (line_input, "retry %d", &retry_count))
1153         ;
1154
1155       else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
1156         address_set++;
1157       else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
1158         {
1159           address_set++;
1160           is_ip4 = 0;
1161         }
1162       else
1163         {
1164           error = clib_error_return (0, "unknown input '%U'",
1165                                      format_unformat_error, line_input);
1166           goto done;
1167         }
1168     }
1169
1170   if (sw_if_index == ~0)
1171     {
1172       error = clib_error_return (0, "Interface required, not set.");
1173       goto done;
1174     }
1175   if (address_set == 0)
1176     {
1177       error = clib_error_return (0, "ip address required, not set.");
1178       goto done;
1179     }
1180   if (address_set > 1)
1181     {
1182       error = clib_error_return (0, "Multiple ip addresses not supported.");
1183       goto done;
1184     }
1185
1186   if (is_ip4)
1187     error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
1188   else
1189     error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
1190
1191 done:
1192   unformat_free (line_input);
1193
1194   return error;
1195 }
1196
1197 /*?
1198  * The '<em>ip probe-neighbor</em>' command ARPs for IPv4 addresses or
1199  * attempts IPv6 neighbor discovery depending on the supplied IP address
1200  * format.
1201  *
1202  * @note This command will not immediately affect the indicated FIB; it
1203  * is not suitable for use in establishing a FIB entry prior to adding
1204  * recursive FIB entries. As in: don't use it in a script to probe a
1205  * gateway prior to adding a default route. It won't work. Instead,
1206  * configure a static ARP cache entry [see '<em>set ip arp</em>'], or
1207  * a static IPv6 neighbor [see '<em>set ip6 neighbor</em>'].
1208  *
1209  * @cliexpar
1210  * Example of probe for an IPv4 address:
1211  * @cliexcmd{ip probe-neighbor GigabitEthernet2/0/0 172.16.1.2}
1212 ?*/
1213 /* *INDENT-OFF* */
1214 VLIB_CLI_COMMAND (ip_probe_neighbor_command, static) = {
1215   .path = "ip probe-neighbor",
1216   .function = probe_neighbor_address,
1217   .short_help = "ip probe-neighbor <interface> <ip4-addr> | <ip6-addr> [retry nn]",
1218   .is_mp_safe = 1,
1219 };
1220 /* *INDENT-ON* */
1221
1222 /*
1223  * fd.io coding-style-patch-verification: ON
1224  *
1225  * Local Variables:
1226  * eval: (c-set-style "gnu")
1227  * End:
1228  */