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