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