src/vnet/fib/ip4_fib.c

   1 /*
   2  * Copyright (c) 2016 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 #include <vnet/fib/fib_table.h>
  17 #include <vnet/fib/fib_entry.h>
  18 #include <vnet/fib/ip4_fib.h>
  19
  20 /*
  21  * A table of prefixes to be added to tables and the sources for them
  22  */
  23 typedef struct ip4_fib_table_special_prefix_t_ {
  24     fib_prefix_t ift_prefix;
  25     fib_source_t ift_source;
  26     fib_entry_flag_t ift_flag;
  27 } ip4_fib_table_special_prefix_t;
  28
  29 static const ip4_fib_table_special_prefix_t ip4_specials[] = {
  30     {
  31         /* 0.0.0.0/0*/
  32         .ift_prefix = {
  33             .fp_addr = {
  34                 .ip4.data_u32 = 0,
  35             },
  36             .fp_len  = 0,
  37             .fp_proto = FIB_PROTOCOL_IP4,
  38         },
  39         .ift_source = FIB_SOURCE_DEFAULT_ROUTE,
  40         .ift_flag   = FIB_ENTRY_FLAG_DROP,
  41     },
  42     {
  43         /* 0.0.0.0/32*/
  44         .ift_prefix = {
  45             .fp_addr = {
  46                 .ip4.data_u32 = 0,
  47             },
  48             .fp_len  = 32,
  49             .fp_proto = FIB_PROTOCOL_IP4,
  50         },
  51         .ift_source = FIB_SOURCE_DEFAULT_ROUTE,
  52         .ift_flag   = FIB_ENTRY_FLAG_DROP,
  53     },
  54     {
  55         /*
  56          * 240.0.0.0/4
  57          * drop class E
  58          */
  59         .ift_prefix = {
  60             .fp_addr = {
  61                 .ip4.data_u32 = 0xf0000000,
  62             },
  63             .fp_len   = 4,
  64             .fp_proto = FIB_PROTOCOL_IP4,
  65         },
  66         .ift_source = FIB_SOURCE_SPECIAL,
  67         .ift_flag   = FIB_ENTRY_FLAG_DROP,
  68
  69     },
  70     {
  71         /*
  72          * 224.0.0.0/4
  73          * drop all mcast
  74          */
  75         .ift_prefix = {
  76             .fp_addr = {
  77                 .ip4.data_u32 = 0xe0000000,
  78             },
  79             .fp_len   = 4,
  80             .fp_proto = FIB_PROTOCOL_IP4,
  81         },
  82         .ift_source = FIB_SOURCE_SPECIAL,
  83         .ift_flag    = FIB_ENTRY_FLAG_DROP,
  84     },
  85     {
  86         /*
  87          * 255.255.255.255/32
  88          * drop, but we'll allow it to be usurped by the likes of DHCP
  89          */
  90         .ift_prefix = {
  91             .fp_addr = {
  92                 .ip4.data_u32 = 0xffffffff,
  93             },
  94             .fp_len   = 32,
  95             .fp_proto = FIB_PROTOCOL_IP4,
  96         },
  97         .ift_source = FIB_SOURCE_DEFAULT_ROUTE,
  98         .ift_flag   = FIB_ENTRY_FLAG_DROP,
  99     }
 100 };
 101
 102
 103 static u32
 104 ip4_create_fib_with_table_id (u32 table_id,
 105                               fib_source_t src)
 106 {
 107     fib_table_t *fib_table;
 108     ip4_fib_t *v4_fib;
 109     void *old_heap;
 110
 111     pool_get(ip4_main.fibs, fib_table);
 112     clib_memset(fib_table, 0, sizeof(*fib_table));
 113
 114     old_heap = clib_mem_set_heap (ip4_main.mtrie_mheap);
 115     pool_get_aligned(ip4_main.v4_fibs, v4_fib, CLIB_CACHE_LINE_BYTES);
 116     clib_mem_set_heap (old_heap);
 117
 118     ASSERT((fib_table - ip4_main.fibs) ==
 119            (v4_fib - ip4_main.v4_fibs));
 120
 121     fib_table->ft_proto = FIB_PROTOCOL_IP4;
 122     fib_table->ft_index =
 123         v4_fib->index =
 124             (fib_table - ip4_main.fibs);
 125
 126     hash_set (ip4_main.fib_index_by_table_id, table_id, fib_table->ft_index);
 127
 128     fib_table->ft_table_id =
 129         v4_fib->table_id =
 130             table_id;
 131     fib_table->ft_flow_hash_config = IP_FLOW_HASH_DEFAULT;
 132
 133     fib_table_lock(fib_table->ft_index, FIB_PROTOCOL_IP4, src);
 134
 135     ip4_mtrie_init(&v4_fib->mtrie);
 136
 137     /*
 138      * add the special entries into the new FIB
 139      */
 140     int ii;
 141
 142     for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
 143     {
 144         fib_prefix_t prefix = ip4_specials[ii].ift_prefix;
 145
 146         prefix.fp_addr.ip4.data_u32 =
 147             clib_host_to_net_u32(prefix.fp_addr.ip4.data_u32);
 148
 149         fib_table_entry_special_add(fib_table->ft_index,
 150                                     &prefix,
 151                                     ip4_specials[ii].ift_source,
 152                                     ip4_specials[ii].ift_flag);
 153     }
 154
 155     return (fib_table->ft_index);
 156 }
 157
 158 void
 159 ip4_fib_table_destroy (u32 fib_index)
 160 {
 161     fib_table_t *fib_table = pool_elt_at_index(ip4_main.fibs, fib_index);
 162     ip4_fib_t *v4_fib = pool_elt_at_index(ip4_main.v4_fibs, fib_index);
 163     int ii;
 164
 165     /*
 166      * remove all the specials we added when the table was created.
 167      * In reverse order so the default route is last.
 168      */
 169     for (ii = ARRAY_LEN(ip4_specials) - 1; ii >= 0; ii--)
 170     {
 171         fib_prefix_t prefix = ip4_specials[ii].ift_prefix;
 172
 173         prefix.fp_addr.ip4.data_u32 =
 174             clib_host_to_net_u32(prefix.fp_addr.ip4.data_u32);
 175
 176         fib_table_entry_special_remove(fib_table->ft_index,
 177                                        &prefix,
 178                                        ip4_specials[ii].ift_source);
 179     }
 180
 181     /*
 182      * validate no more routes.
 183      */
 184     ASSERT(0 == fib_table->ft_total_route_counts);
 185     FOR_EACH_FIB_SOURCE(ii)
 186     {
 187         ASSERT(0 == fib_table->ft_src_route_counts[ii]);
 188     }
 189
 190     if (~0 != fib_table->ft_table_id)
 191     {
 192         hash_unset (ip4_main.fib_index_by_table_id, fib_table->ft_table_id);
 193     }
 194
 195     ip4_mtrie_free(&v4_fib->mtrie);
 196
 197     pool_put(ip4_main.v4_fibs, v4_fib);
 198     pool_put(ip4_main.fibs, fib_table);
 199 }
 200
 201
 202 u32
 203 ip4_fib_table_find_or_create_and_lock (u32 table_id,
 204                                        fib_source_t src)
 205 {
 206     u32 index;
 207
 208     index = ip4_fib_index_from_table_id(table_id);
 209     if (~0 == index)
 210         return ip4_create_fib_with_table_id(table_id, src);
 211
 212     fib_table_lock(index, FIB_PROTOCOL_IP4, src);
 213
 214     return (index);
 215 }
 216
 217 u32
 218 ip4_fib_table_create_and_lock (fib_source_t src)
 219 {
 220     return (ip4_create_fib_with_table_id(~0, src));
 221 }
 222
 223 u32
 224 ip4_fib_table_get_index_for_sw_if_index (u32 sw_if_index)
 225 {
 226     if (sw_if_index >= vec_len(ip4_main.fib_index_by_sw_if_index))
 227     {
 228         /*
 229          * This is the case for interfaces that are not yet mapped to
 230          * a IP table
 231          */
 232         return (~0);
 233     }
 234     return (ip4_main.fib_index_by_sw_if_index[sw_if_index]);
 235 }
 236
 237 /*
 238  * ip4_fib_table_lookup_exact_match
 239  *
 240  * Exact match prefix lookup
 241  */
 242 fib_node_index_t
 243 ip4_fib_table_lookup_exact_match (const ip4_fib_t *fib,
 244                                   const ip4_address_t *addr,
 245                                   u32 len)
 246 {
 247     uword * hash, * result;
 248     u32 key;
 249
 250     hash = fib->fib_entry_by_dst_address[len];
 251     key  = (addr->data_u32 & ip4_main.fib_masks[len]);
 252
 253     result = hash_get(hash, key);
 254
 255     if (NULL != result) {
 256         return (result[0]);
 257     }
 258     return (FIB_NODE_INDEX_INVALID);
 259 }
 260
 261 /*
 262  * ip4_fib_table_lookup_adj
 263  *
 264  * Longest prefix match
 265  */
 266 index_t
 267 ip4_fib_table_lookup_lb (ip4_fib_t *fib,
 268                          const ip4_address_t *addr)
 269 {
 270     fib_node_index_t fei;
 271
 272     fei = ip4_fib_table_lookup(fib, addr, 32);
 273
 274     if (FIB_NODE_INDEX_INVALID != fei)
 275     {
 276         const dpo_id_t *dpo;
 277
 278         dpo = fib_entry_contribute_ip_forwarding(fei);
 279
 280         return (dpo->dpoi_index);
 281     }
 282     return (INDEX_INVALID);
 283 }
 284
 285 /*
 286  * ip4_fib_table_lookup
 287  *
 288  * Longest prefix match
 289  */
 290 fib_node_index_t
 291 ip4_fib_table_lookup (const ip4_fib_t *fib,
 292                       const ip4_address_t *addr,
 293                       u32 len)
 294 {
 295     uword * hash, * result;
 296     i32 mask_len;
 297     u32 key;
 298
 299     for (mask_len = len; mask_len >= 0; mask_len--)
 300     {
 301         hash = fib->fib_entry_by_dst_address[mask_len];
 302         key = (addr->data_u32 & ip4_main.fib_masks[mask_len]);
 303
 304         result = hash_get (hash, key);
 305
 306         if (NULL != result) {
 307             return (result[0]);
 308         }
 309     }
 310     return (FIB_NODE_INDEX_INVALID);
 311 }
 312
 313 void
 314 ip4_fib_table_entry_insert (ip4_fib_t *fib,
 315                             const ip4_address_t *addr,
 316                             u32 len,
 317                             fib_node_index_t fib_entry_index)
 318 {
 319     uword * hash, * result;
 320     u32 key;
 321
 322     key = (addr->data_u32 & ip4_main.fib_masks[len]);
 323     hash = fib->fib_entry_by_dst_address[len];
 324     result = hash_get (hash, key);
 325
 326     if (NULL == result) {
 327         /*
 328          * adding a new entry
 329          */
 330         uword *old_heap;
 331         old_heap = clib_mem_set_heap (ip4_main.mtrie_mheap);
 332
 333         if (NULL == hash) {
 334             hash = hash_create (32 /* elts */, sizeof (uword));
 335             hash_set_flags (hash, HASH_FLAG_NO_AUTO_SHRINK);
 336
 337         }
 338         hash = hash_set(hash, key, fib_entry_index);
 339         fib->fib_entry_by_dst_address[len] = hash;
 340         clib_mem_set_heap (old_heap);
 341     }
 342     else
 343     {
 344         ASSERT(0);
 345     }
 346 }
 347
 348 void
 349 ip4_fib_table_entry_remove (ip4_fib_t *fib,
 350                             const ip4_address_t *addr,
 351                             u32 len)
 352 {
 353     uword * hash, * result;
 354     u32 key;
 355
 356     key = (addr->data_u32 & ip4_main.fib_masks[len]);
 357     hash = fib->fib_entry_by_dst_address[len];
 358     result = hash_get (hash, key);
 359
 360     if (NULL == result)
 361     {
 362         /*
 363          * removing a non-existent entry. i'll allow it.
 364          */
 365     }
 366     else
 367     {
 368         uword *old_heap;
 369
 370         old_heap = clib_mem_set_heap (ip4_main.mtrie_mheap);
 371         hash_unset(hash, key);
 372         clib_mem_set_heap (old_heap);
 373     }
 374
 375     fib->fib_entry_by_dst_address[len] = hash;
 376 }
 377
 378 void
 379 ip4_fib_table_fwding_dpo_update (ip4_fib_t *fib,
 380                                  const ip4_address_t *addr,
 381                                  u32 len,
 382                                  const dpo_id_t *dpo)
 383 {
 384     ip4_fib_mtrie_route_add(&fib->mtrie, addr, len, dpo->dpoi_index);
 385 }
 386
 387 void
 388 ip4_fib_table_fwding_dpo_remove (ip4_fib_t *fib,
 389                                  const ip4_address_t *addr,
 390                                  u32 len,
 391                                  const dpo_id_t *dpo,
 392                                  u32 cover_index)
 393 {
 394     const fib_prefix_t *cover_prefix;
 395     const dpo_id_t *cover_dpo;
 396
 397     /*
 398      * We need to pass the MTRIE the LB index and address length of the
 399      * covering prefix, so it can fill the plys with the correct replacement
 400      * for the entry being removed
 401      */
 402     cover_prefix = fib_entry_get_prefix(cover_index);
 403     cover_dpo = fib_entry_contribute_ip_forwarding(cover_index);
 404
 405     ip4_fib_mtrie_route_del(&fib->mtrie,
 406                             addr, len, dpo->dpoi_index,
 407                             cover_prefix->fp_len,
 408                             cover_dpo->dpoi_index);
 409 }
 410
 411 void
 412 ip4_fib_table_walk (ip4_fib_t *fib,
 413                     fib_table_walk_fn_t fn,
 414                     void *ctx)
 415 {
 416     fib_prefix_t root = {
 417         .fp_proto = FIB_PROTOCOL_IP4,
 418         // address and length default to all 0
 419     };
 420
 421     /*
 422      * A full tree walk is the dengenerate case of a sub-tree from
 423      * the very root
 424      */
 425     return (ip4_fib_table_sub_tree_walk(fib, &root, fn, ctx));
 426 }
 427
 428 void
 429 ip4_fib_table_sub_tree_walk (ip4_fib_t *fib,
 430                              const fib_prefix_t *root,
 431                              fib_table_walk_fn_t fn,
 432                              void *ctx)
 433 {
 434     fib_prefix_t *sub_trees = NULL;
 435     int i;
 436
 437     /*
 438      * There is no efficient way to walk this array of hash tables.
 439      * so we walk each table with a mask length greater than and equal to
 440      * the required root and check it is covered by the root.
 441      */
 442     for (i = root->fp_len;
 443          i < ARRAY_LEN (fib->fib_entry_by_dst_address);
 444          i++)
 445     {
 446         uword * hash = fib->fib_entry_by_dst_address[i];
 447
 448         if (NULL != hash)
 449         {
 450             ip4_address_t key;
 451             hash_pair_t * p;
 452
 453             hash_foreach_pair (p, hash,
 454             ({
 455                 key.as_u32 = p->key;
 456                 if (ip4_destination_matches_route(&ip4_main,
 457                                                   &key,
 458                                                   &root->fp_addr.ip4,
 459                                                   root->fp_len))
 460                 {
 461                     const fib_prefix_t *sub_tree;
 462                     int skip = 0;
 463
 464                     /*
 465                      * exclude sub-trees the walk does not want to explore
 466                      */
 467                     vec_foreach(sub_tree, sub_trees)
 468                     {
 469                         if (ip4_destination_matches_route(&ip4_main,
 470                                                           &key,
 471                                                           &sub_tree->fp_addr.ip4,
 472                                                           sub_tree->fp_len))
 473                         {
 474                             skip = 1;
 475                             break;
 476                         }
 477                     }
 478
 479                     if (!skip)
 480                     {
 481                         switch (fn(p->value[0], ctx))
 482                         {
 483                         case FIB_TABLE_WALK_CONTINUE:
 484                             break;
 485                         case FIB_TABLE_WALK_SUB_TREE_STOP: {
 486                             fib_prefix_t pfx = {
 487                                 .fp_proto = FIB_PROTOCOL_IP4,
 488                                 .fp_len = i,
 489                                 .fp_addr.ip4 = key,
 490                             };
 491                             vec_add1(sub_trees, pfx);
 492                             break;
 493                         }
 494                         case FIB_TABLE_WALK_STOP:
 495                             goto done;
 496                         }
 497                     }
 498                 }
 499             }));
 500         }
 501     }
 502 done:
 503     vec_free(sub_trees);
 504     return;
 505 }
 506
 507 /**
 508  * Walk show context
 509  */
 510 typedef struct ip4_fib_show_walk_ctx_t_
 511 {
 512     fib_node_index_t *ifsw_indicies;
 513 } ip4_fib_show_walk_ctx_t;
 514
 515 static fib_table_walk_rc_t
 516 ip4_fib_show_walk_cb (fib_node_index_t fib_entry_index,
 517                       void *arg)
 518 {
 519     ip4_fib_show_walk_ctx_t *ctx = arg;
 520
 521     vec_add1(ctx->ifsw_indicies, fib_entry_index);
 522
 523     return (FIB_TABLE_WALK_CONTINUE);
 524 }
 525
 526 static void
 527 ip4_fib_table_show_all (ip4_fib_t *fib,
 528                         vlib_main_t * vm)
 529 {
 530     ip4_fib_show_walk_ctx_t ctx = {
 531         .ifsw_indicies = NULL,
 532     };
 533     fib_node_index_t *fib_entry_index;
 534
 535     ip4_fib_table_walk(fib, ip4_fib_show_walk_cb, &ctx);
 536     vec_sort_with_function(ctx.ifsw_indicies,
 537                            fib_entry_cmp_for_sort);
 538
 539     vec_foreach(fib_entry_index, ctx.ifsw_indicies)
 540     {
 541         vlib_cli_output(vm, "%U",
 542                         format_fib_entry,
 543                         *fib_entry_index,
 544                         FIB_ENTRY_FORMAT_BRIEF);
 545     }
 546
 547     vec_free(ctx.ifsw_indicies);
 548 }
 549
 550 static void
 551 ip4_fib_table_show_one (ip4_fib_t *fib,
 552                         vlib_main_t * vm,
 553                         ip4_address_t *address,
 554                         u32 mask_len,
 555                         int detail)
 556 {
 557     vlib_cli_output(vm, "%U",
 558                     format_fib_entry,
 559                     ip4_fib_table_lookup(fib, address, mask_len),
 560                     (detail ?
 561                      FIB_ENTRY_FORMAT_DETAIL2 :
 562                      FIB_ENTRY_FORMAT_DETAIL));
 563 }
 564
 565 u8 *
 566 format_ip4_fib_table_memory (u8 * s, va_list * args)
 567 {
 568 #if USE_DLMALLOC == 0
 569     s = format(s, "%=30s %=6d %=12ld\n",
 570                "IPv4 unicast",
 571                pool_elts(ip4_main.fibs),
 572                mheap_bytes(ip4_main.mtrie_mheap));
 573 #else
 574     s = format(s, "%=30s %=6d %=12ld\n",
 575                "IPv4 unicast",
 576                pool_elts(ip4_main.fibs),
 577                mspace_footprint(ip4_main.mtrie_mheap));
 578 #endif
 579
 580
 581     return (s);
 582 }
 583
 584 static clib_error_t *
 585 ip4_show_fib (vlib_main_t * vm,
 586               unformat_input_t * input,
 587               vlib_cli_command_t * cmd)
 588 {
 589     ip4_main_t * im4 = &ip4_main;
 590     fib_table_t * fib_table;
 591     u64 total_mtrie_memory, total_hash_memory;
 592     int verbose, matching, mtrie, memory;
 593     ip4_address_t matching_address;
 594     u32 matching_mask = 32;
 595     int i, table_id = -1, fib_index = ~0;
 596     int detail = 0;
 597
 598     verbose = 1;
 599     matching = mtrie = memory = 0;
 600     total_hash_memory = total_mtrie_memory = 0;
 601
 602     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 603     {
 604         if (unformat (input, "brief") || unformat (input, "summary")
 605             || unformat (input, "sum"))
 606             verbose = 0;
 607
 608         else if (unformat (input, "detail") || unformat (input, "det"))
 609             detail = 1;
 610
 611         else if (unformat (input, "mtrie"))
 612             mtrie = 1;
 613
 614         else if (unformat (input, "mem") ||
 615                  unformat (input, "memory"))
 616             memory = 1;
 617
 618         else if (unformat (input, "%U/%d",
 619                            unformat_ip4_address, &matching_address, &matching_mask))
 620             matching = 1;
 621
 622         else if (unformat (input, "%U", unformat_ip4_address, &matching_address))
 623             matching = 1;
 624
 625         else if (unformat (input, "table %d", &table_id))
 626             ;
 627         else if (unformat (input, "index %d", &fib_index))
 628             ;
 629         else
 630             break;
 631     }
 632
 633     pool_foreach (fib_table, im4->fibs,
 634     ({
 635         ip4_fib_t *fib = pool_elt_at_index(im4->v4_fibs, fib_table->ft_index);
 636         fib_source_t source;
 637         u8 *s = NULL;
 638
 639         if (table_id >= 0 && table_id != (int)fib->table_id)
 640             continue;
 641         if (fib_index != ~0 && fib_index != (int)fib->index)
 642             continue;
 643
 644         if (memory)
 645         {
 646             uword mtrie_size, hash_size, *old_heap;
 647
 648
 649             mtrie_size = ip4_fib_mtrie_memory_usage(&fib->mtrie);
 650             hash_size = 0;
 651
 652             old_heap = clib_mem_set_heap (ip4_main.mtrie_mheap);
 653             for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
 654             {
 655                 uword * hash = fib->fib_entry_by_dst_address[i];
 656                 if (NULL != hash)
 657                 {
 658                     hash_size += hash_bytes(hash);
 659                 }
 660             }
 661             clib_mem_set_heap (old_heap);
 662
 663             if (verbose)
 664                 vlib_cli_output (vm, "%U mtrie:%d hash:%d",
 665                                  format_fib_table_name, fib->index,
 666                                  FIB_PROTOCOL_IP4,
 667                                  mtrie_size,
 668                                  hash_size);
 669             total_mtrie_memory += mtrie_size;
 670             total_hash_memory += hash_size;
 671             continue;
 672         }
 673
 674         s = format(s, "%U, fib_index:%d, flow hash:[%U] epoch:%d flags:%U locks:[",
 675                    format_fib_table_name, fib->index,
 676                    FIB_PROTOCOL_IP4,
 677                    fib->index,
 678                    format_ip_flow_hash_config,
 679                    fib_table->ft_flow_hash_config,
 680                    fib_table->ft_epoch,
 681                    format_fib_table_flags, fib_table->ft_flags);
 682         FOR_EACH_FIB_SOURCE(source)
 683         {
 684             if (0 != fib_table->ft_locks[source])
 685             {
 686                 s = format(s, "%U:%d, ",
 687                            format_fib_source, source,
 688                            fib_table->ft_locks[source]);
 689             }
 690         }
 691         s = format (s, "]");
 692         vlib_cli_output (vm, "%v", s);
 693         vec_free(s);
 694
 695         /* Show summary? */
 696         if (mtrie)
 697         {
 698             vlib_cli_output (vm, "%U", format_ip4_fib_mtrie, &fib->mtrie, verbose);
 699             continue;
 700         }
 701         if (! verbose)
 702         {
 703             vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
 704             for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
 705             {
 706                 uword * hash = fib->fib_entry_by_dst_address[i];
 707                 uword n_elts = hash_elts (hash);
 708                 if (n_elts > 0)
 709                     vlib_cli_output (vm, "%20d%16d", i, n_elts);
 710             }
 711             continue;
 712         }
 713
 714         if (!matching)
 715         {
 716             ip4_fib_table_show_all(fib, vm);
 717         }
 718         else
 719         {
 720             ip4_fib_table_show_one(fib, vm, &matching_address,
 721                                    matching_mask, detail);
 722         }
 723     }));
 724
 725     if (memory)
 726     {
 727         vlib_cli_output (vm, "totals: mtrie:%ld hash:%ld all:%ld",
 728                          total_mtrie_memory,
 729                          total_hash_memory,
 730                          total_mtrie_memory + total_hash_memory);
 731         vlib_cli_output (vm, "\nMtrie Mheap Usage: %U\n",
 732                          format_mheap, ip4_main.mtrie_mheap, 1);
 733     }
 734     return 0;
 735 }
 736
 737 /*?
 738  * This command displays the IPv4 FIB Tables (VRF Tables) and the route
 739  * entries for each table.
 740  *
 741  * @note This command will run for a long time when the FIB tables are
 742  * comprised of millions of entries. For those senarios, consider displaying
 743  * a single table or summary mode.
 744  *
 745  * @cliexpar
 746  * Example of how to display all the IPv4 FIB tables:
 747  * @cliexstart{show ip fib}
 748  * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
 749  * 0.0.0.0/0
 750  *   unicast-ip4-chain
 751  *   [@0]: dpo-load-balance: [index:0 buckets:1 uRPF:0 to:[0:0]]
 752  *     [0] [@0]: dpo-drop ip6
 753  * 0.0.0.0/32
 754  *   unicast-ip4-chain
 755  *   [@0]: dpo-load-balance: [index:1 buckets:1 uRPF:1 to:[0:0]]
 756  *     [0] [@0]: dpo-drop ip6
 757  * 6.0.1.2/32
 758  *   unicast-ip4-chain
 759  *   [@0]: dpo-load-balance: [index:30 buckets:1 uRPF:29 to:[0:0]]
 760  *     [0] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
 761  * 7.0.0.1/32
 762  *   unicast-ip4-chain
 763  *   [@0]: dpo-load-balance: [index:31 buckets:4 uRPF:30 to:[0:0]]
 764  *     [0] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
 765  *     [1] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
 766  *     [2] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
 767  *     [3] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
 768  * 224.0.0.0/8
 769  *   unicast-ip4-chain
 770  *   [@0]: dpo-load-balance: [index:3 buckets:1 uRPF:3 to:[0:0]]
 771  *     [0] [@0]: dpo-drop ip6
 772  * 240.0.0.0/8
 773  *   unicast-ip4-chain
 774  *   [@0]: dpo-load-balance: [index:2 buckets:1 uRPF:2 to:[0:0]]
 775  *     [0] [@0]: dpo-drop ip6
 776  * 255.255.255.255/32
 777  *   unicast-ip4-chain
 778  *   [@0]: dpo-load-balance: [index:4 buckets:1 uRPF:4 to:[0:0]]
 779  *     [0] [@0]: dpo-drop ip6
 780  * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
 781  * 0.0.0.0/0
 782  *   unicast-ip4-chain
 783  *   [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
 784  *     [0] [@0]: dpo-drop ip6
 785  * 0.0.0.0/32
 786  *   unicast-ip4-chain
 787  *   [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
 788  *     [0] [@0]: dpo-drop ip6
 789  * 172.16.1.0/24
 790  *   unicast-ip4-chain
 791  *   [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
 792  *     [0] [@4]: ipv4-glean: af_packet0
 793  * 172.16.1.1/32
 794  *   unicast-ip4-chain
 795  *   [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
 796  *     [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
 797  * 172.16.1.2/32
 798  *   unicast-ip4-chain
 799  *   [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
 800  *     [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
 801  * 172.16.2.0/24
 802  *   unicast-ip4-chain
 803  *   [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
 804  *     [0] [@4]: ipv4-glean: af_packet1
 805  * 172.16.2.1/32
 806  *   unicast-ip4-chain
 807  *   [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
 808  *     [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
 809  * 224.0.0.0/8
 810  *   unicast-ip4-chain
 811  *   [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
 812  *     [0] [@0]: dpo-drop ip6
 813  * 240.0.0.0/8
 814  *   unicast-ip4-chain
 815  *   [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
 816  *     [0] [@0]: dpo-drop ip6
 817  * 255.255.255.255/32
 818  *   unicast-ip4-chain
 819  *   [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
 820  *     [0] [@0]: dpo-drop ip6
 821  * @cliexend
 822  * Example of how to display a single IPv4 FIB table:
 823  * @cliexstart{show ip fib table 7}
 824  * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
 825  * 0.0.0.0/0
 826  *   unicast-ip4-chain
 827  *   [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
 828  *     [0] [@0]: dpo-drop ip6
 829  * 0.0.0.0/32
 830  *   unicast-ip4-chain
 831  *   [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
 832  *     [0] [@0]: dpo-drop ip6
 833  * 172.16.1.0/24
 834  *   unicast-ip4-chain
 835  *   [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
 836  *     [0] [@4]: ipv4-glean: af_packet0
 837  * 172.16.1.1/32
 838  *   unicast-ip4-chain
 839  *   [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
 840  *     [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
 841  * 172.16.1.2/32
 842  *   unicast-ip4-chain
 843  *   [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
 844  *     [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
 845  * 172.16.2.0/24
 846  *   unicast-ip4-chain
 847  *   [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
 848  *     [0] [@4]: ipv4-glean: af_packet1
 849  * 172.16.2.1/32
 850  *   unicast-ip4-chain
 851  *   [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
 852  *     [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
 853  * 224.0.0.0/8
 854  *   unicast-ip4-chain
 855  *   [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
 856  *     [0] [@0]: dpo-drop ip6
 857  * 240.0.0.0/8
 858  *   unicast-ip4-chain
 859  *   [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
 860  *     [0] [@0]: dpo-drop ip6
 861  * 255.255.255.255/32
 862  *   unicast-ip4-chain
 863  *   [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
 864  *     [0] [@0]: dpo-drop ip6
 865  * @cliexend
 866  * Example of how to display a summary of all IPv4 FIB tables:
 867  * @cliexstart{show ip fib summary}
 868  * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
 869  *     Prefix length         Count
 870  *                    0               1
 871  *                    8               2
 872  *                   32               4
 873  * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
 874  *     Prefix length         Count
 875  *                    0               1
 876  *                    8               2
 877  *                   24               2
 878  *                   32               4
 879  * @cliexend
 880  ?*/
 881 /* *INDENT-OFF* */
 882 VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
 883     .path = "show ip fib",
 884     .short_help = "show ip fib [summary] [table <table-id>] [index <fib-id>] [<ip4-addr>[/<mask>]] [mtrie] [detail]",
 885     .function = ip4_show_fib,
 886 };
 887 /* *INDENT-ON* */