src/vnet/fib/fib_table.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 <vlib/vlib.h>
  17 #include <vnet/dpo/drop_dpo.h>
  18
  19 #include <vnet/fib/fib_table.h>
  20 #include <vnet/fib/fib_entry_cover.h>
  21 #include <vnet/fib/fib_internal.h>
  22 #include <vnet/fib/ip4_fib.h>
  23 #include <vnet/fib/ip6_fib.h>
  24 #include <vnet/fib/mpls_fib.h>
  25
  26 fib_table_t *
  27 fib_table_get (fib_node_index_t index,
  28                fib_protocol_t proto)
  29 {
  30     switch (proto)
  31     {
  32     case FIB_PROTOCOL_IP4:
  33         return (pool_elt_at_index(ip4_main.fibs, index));
  34     case FIB_PROTOCOL_IP6:
  35         return (pool_elt_at_index(ip6_main.fibs, index));
  36     case FIB_PROTOCOL_MPLS:
  37         return (pool_elt_at_index(mpls_main.fibs, index));
  38     }
  39     ASSERT(0);
  40     return (NULL);
  41 }
  42
  43 static inline fib_node_index_t
  44 fib_table_lookup_i (fib_table_t *fib_table,
  45                     const fib_prefix_t *prefix)
  46 {
  47     switch (prefix->fp_proto)
  48     {
  49     case FIB_PROTOCOL_IP4:
  50         return (ip4_fib_table_lookup(ip4_fib_get(fib_table->ft_index),
  51                                      &prefix->fp_addr.ip4,
  52                                      prefix->fp_len));
  53     case FIB_PROTOCOL_IP6:
  54         return (ip6_fib_table_lookup(fib_table->ft_index,
  55                                      &prefix->fp_addr.ip6,
  56                                      prefix->fp_len));
  57     case FIB_PROTOCOL_MPLS:
  58         return (mpls_fib_table_lookup(mpls_fib_get(fib_table->ft_index),
  59                                       prefix->fp_label,
  60                                       prefix->fp_eos));
  61     }
  62     return (FIB_NODE_INDEX_INVALID);
  63 }
  64
  65 fib_node_index_t
  66 fib_table_lookup (u32 fib_index,
  67                   const fib_prefix_t *prefix)
  68 {
  69     return (fib_table_lookup_i(fib_table_get(fib_index, prefix->fp_proto), prefix));
  70 }
  71
  72 static inline fib_node_index_t
  73 fib_table_lookup_exact_match_i (const fib_table_t *fib_table,
  74                                 const fib_prefix_t *prefix)
  75 {
  76     switch (prefix->fp_proto)
  77     {
  78     case FIB_PROTOCOL_IP4:
  79         return (ip4_fib_table_lookup_exact_match(ip4_fib_get(fib_table->ft_index),
  80                                                  &prefix->fp_addr.ip4,
  81                                                  prefix->fp_len));
  82     case FIB_PROTOCOL_IP6:
  83         return (ip6_fib_table_lookup_exact_match(fib_table->ft_index,
  84                                                  &prefix->fp_addr.ip6,
  85                                                  prefix->fp_len));
  86     case FIB_PROTOCOL_MPLS:
  87         return (mpls_fib_table_lookup(mpls_fib_get(fib_table->ft_index),
  88                                       prefix->fp_label,
  89                                       prefix->fp_eos));
  90     }
  91     return (FIB_NODE_INDEX_INVALID);
  92 }
  93
  94 fib_node_index_t
  95 fib_table_lookup_exact_match (u32 fib_index,
  96                               const fib_prefix_t *prefix)
  97 {
  98     return (fib_table_lookup_exact_match_i(fib_table_get(fib_index,
  99                                                          prefix->fp_proto),
 100                                            prefix));
 101 }
 102
 103 static fib_node_index_t
 104 fib_table_get_less_specific_i (fib_table_t *fib_table,
 105                                const fib_prefix_t *prefix)
 106 {
 107     fib_prefix_t pfx;
 108
 109     pfx = *prefix;
 110
 111     if (FIB_PROTOCOL_MPLS == pfx.fp_proto)
 112     {
 113         return (FIB_NODE_INDEX_INVALID);
 114     }
 115
 116     /*
 117      * in the absence of a tree structure for the table that allows for an O(1)
 118      * parent get, a cheeky way to find the cover is to LPM for the prefix with
 119      * mask-1.
 120      * there should always be a cover, though it may be the default route. the
 121      * default route's cover is the default route.
 122      */
 123     if (pfx.fp_len != 0) {
 124         pfx.fp_len -= 1;
 125     }
 126
 127     return (fib_table_lookup_i(fib_table, &pfx));
 128 }
 129
 130 fib_node_index_t
 131 fib_table_get_less_specific (u32 fib_index,
 132                              const fib_prefix_t *prefix)
 133 {
 134     return (fib_table_get_less_specific_i(fib_table_get(fib_index,
 135                                                         prefix->fp_proto),
 136                                           prefix));
 137 }
 138
 139 static void
 140 fib_table_entry_remove (fib_table_t *fib_table,
 141                         const fib_prefix_t *prefix,
 142                         fib_node_index_t fib_entry_index)
 143 {
 144     vlib_smp_unsafe_warning();
 145
 146     fib_table->ft_total_route_counts--;
 147
 148     switch (prefix->fp_proto)
 149     {
 150     case FIB_PROTOCOL_IP4:
 151         ip4_fib_table_entry_remove(ip4_fib_get(fib_table->ft_index),
 152                                    &prefix->fp_addr.ip4,
 153                                    prefix->fp_len);
 154         break;
 155     case FIB_PROTOCOL_IP6:
 156         ip6_fib_table_entry_remove(fib_table->ft_index,
 157                                    &prefix->fp_addr.ip6,
 158                                    prefix->fp_len);
 159         break;
 160     case FIB_PROTOCOL_MPLS:
 161         mpls_fib_table_entry_remove(mpls_fib_get(fib_table->ft_index),
 162                                     prefix->fp_label,
 163                                     prefix->fp_eos);
 164         break;
 165     }
 166
 167     fib_entry_unlock(fib_entry_index);
 168 }
 169
 170 static void
 171 fib_table_post_insert_actions (fib_table_t *fib_table,
 172                                const fib_prefix_t *prefix,
 173                                fib_node_index_t fib_entry_index)
 174 {
 175     fib_node_index_t fib_entry_cover_index;
 176
 177     /*
 178      * no cover relationships in the MPLS FIB
 179      */
 180     if (FIB_PROTOCOL_MPLS == prefix->fp_proto)
 181         return;
 182
 183     /*
 184      * find and inform the covering entry that a new more specific
 185      * has been inserted beneath it
 186      */
 187     fib_entry_cover_index = fib_table_get_less_specific_i(fib_table, prefix);
 188     /*
 189      * the indicies are the same when the default route is first added
 190      */
 191     if (fib_entry_cover_index != fib_entry_index)
 192     {
 193         fib_entry_cover_change_notify(fib_entry_cover_index,
 194                                       fib_entry_index);
 195     }
 196 }
 197
 198 static void
 199 fib_table_entry_insert (fib_table_t *fib_table,
 200                         const fib_prefix_t *prefix,
 201                         fib_node_index_t fib_entry_index)
 202 {
 203     vlib_smp_unsafe_warning();
 204
 205     fib_entry_lock(fib_entry_index);
 206     fib_table->ft_total_route_counts++;
 207
 208     switch (prefix->fp_proto)
 209     {
 210     case FIB_PROTOCOL_IP4:
 211         ip4_fib_table_entry_insert(ip4_fib_get(fib_table->ft_index),
 212                                    &prefix->fp_addr.ip4,
 213                                    prefix->fp_len,
 214                                    fib_entry_index);
 215         break;
 216     case FIB_PROTOCOL_IP6:
 217         ip6_fib_table_entry_insert(fib_table->ft_index,
 218                                    &prefix->fp_addr.ip6,
 219                                    prefix->fp_len,
 220                                    fib_entry_index);
 221         break;
 222     case FIB_PROTOCOL_MPLS:
 223         mpls_fib_table_entry_insert(mpls_fib_get(fib_table->ft_index),
 224                                     prefix->fp_label,
 225                                     prefix->fp_eos,
 226                                     fib_entry_index);
 227         break;
 228     }
 229
 230     fib_table_post_insert_actions(fib_table, prefix, fib_entry_index);
 231 }
 232
 233 void
 234 fib_table_fwding_dpo_update (u32 fib_index,
 235                              const fib_prefix_t *prefix,
 236                              const dpo_id_t *dpo)
 237 {
 238     vlib_smp_unsafe_warning();
 239
 240     switch (prefix->fp_proto)
 241     {
 242     case FIB_PROTOCOL_IP4:
 243         return (ip4_fib_table_fwding_dpo_update(ip4_fib_get(fib_index),
 244                                                 &prefix->fp_addr.ip4,
 245                                                 prefix->fp_len,
 246                                                 dpo));
 247     case FIB_PROTOCOL_IP6:
 248         return (ip6_fib_table_fwding_dpo_update(fib_index,
 249                                                 &prefix->fp_addr.ip6,
 250                                                 prefix->fp_len,
 251                                                 dpo));
 252     case FIB_PROTOCOL_MPLS:
 253         return (mpls_fib_forwarding_table_update(mpls_fib_get(fib_index),
 254                                                  prefix->fp_label,
 255                                                  prefix->fp_eos,
 256                                                  dpo));
 257     }
 258 }
 259
 260 void
 261 fib_table_fwding_dpo_remove (u32 fib_index,
 262                              const fib_prefix_t *prefix,
 263                              const dpo_id_t *dpo)
 264 {
 265     vlib_smp_unsafe_warning();
 266
 267     switch (prefix->fp_proto)
 268     {
 269     case FIB_PROTOCOL_IP4:
 270         return (ip4_fib_table_fwding_dpo_remove(ip4_fib_get(fib_index),
 271                                                 &prefix->fp_addr.ip4,
 272                                                 prefix->fp_len,
 273                                                 dpo,
 274                                                 fib_table_get_less_specific(fib_index,
 275                                                                             prefix)));
 276     case FIB_PROTOCOL_IP6:
 277         return (ip6_fib_table_fwding_dpo_remove(fib_index,
 278                                                 &prefix->fp_addr.ip6,
 279                                                 prefix->fp_len,
 280                                                 dpo));
 281     case FIB_PROTOCOL_MPLS:
 282         return (mpls_fib_forwarding_table_reset(mpls_fib_get(fib_index),
 283                                                 prefix->fp_label,
 284                                                 prefix->fp_eos));
 285     }
 286 }
 287
 288
 289 fib_node_index_t
 290 fib_table_entry_special_dpo_add (u32 fib_index,
 291                                  const fib_prefix_t *prefix,
 292                                  fib_source_t source,
 293                                  fib_entry_flag_t flags,
 294                                  const dpo_id_t *dpo)
 295 {
 296     fib_node_index_t fib_entry_index;
 297     fib_table_t *fib_table;
 298
 299     fib_table = fib_table_get(fib_index, prefix->fp_proto);
 300     fib_entry_index = fib_table_lookup_exact_match_i(fib_table, prefix);
 301
 302     if (FIB_NODE_INDEX_INVALID == fib_entry_index)
 303     {
 304         fib_entry_index = fib_entry_create_special(fib_index, prefix,
 305                                                    source, flags,
 306                                                    dpo);
 307
 308         fib_table_entry_insert(fib_table, prefix, fib_entry_index);
 309         fib_table->ft_src_route_counts[source]++;
 310     }
 311     else
 312     {
 313         int was_sourced;
 314
 315         was_sourced = fib_entry_is_sourced(fib_entry_index, source);
 316         fib_entry_special_add(fib_entry_index, source, flags, dpo);
 317
 318         if (was_sourced != fib_entry_is_sourced(fib_entry_index, source))
 319         {
 320             fib_table->ft_src_route_counts[source]++;
 321         }
 322     }
 323
 324
 325     return (fib_entry_index);
 326 }
 327
 328 fib_node_index_t
 329 fib_table_entry_special_dpo_update (u32 fib_index,
 330                                     const fib_prefix_t *prefix,
 331                                     fib_source_t source,
 332                                     fib_entry_flag_t flags,
 333                                     const dpo_id_t *dpo)
 334 {
 335     fib_node_index_t fib_entry_index;
 336     fib_table_t *fib_table;
 337
 338     fib_table = fib_table_get(fib_index, prefix->fp_proto);
 339     fib_entry_index = fib_table_lookup_exact_match_i(fib_table, prefix);
 340
 341     if (FIB_NODE_INDEX_INVALID == fib_entry_index)
 342     {
 343         fib_entry_index = fib_entry_create_special(fib_index, prefix,
 344                                                    source, flags,
 345                                                    dpo);
 346
 347         fib_table_entry_insert(fib_table, prefix, fib_entry_index);
 348         fib_table->ft_src_route_counts[source]++;
 349     }
 350     else
 351     {
 352         int was_sourced;
 353
 354         was_sourced = fib_entry_is_sourced(fib_entry_index, source);
 355
 356         if (was_sourced)
 357             fib_entry_special_update(fib_entry_index, source, flags, dpo);
 358         else
 359             fib_entry_special_add(fib_entry_index, source, flags, dpo);
 360
 361         if (was_sourced != fib_entry_is_sourced(fib_entry_index, source))
 362         {
 363             fib_table->ft_src_route_counts[source]++;
 364         }
 365     }
 366
 367     return (fib_entry_index);
 368 }
 369
 370 fib_node_index_t
 371 fib_table_entry_special_add (u32 fib_index,
 372                              const fib_prefix_t *prefix,
 373                              fib_source_t source,
 374                              fib_entry_flag_t flags)
 375 {
 376     fib_node_index_t fib_entry_index;
 377     dpo_id_t tmp_dpo = DPO_INVALID;
 378
 379     dpo_copy(&tmp_dpo, drop_dpo_get(fib_proto_to_dpo(prefix->fp_proto)));
 380
 381     fib_entry_index = fib_table_entry_special_dpo_add(fib_index, prefix, source,
 382                                                       flags, &tmp_dpo);
 383
 384     dpo_unlock(&tmp_dpo);
 385
 386     return (fib_entry_index);
 387 }
 388
 389 void
 390 fib_table_entry_special_remove (u32 fib_index,
 391                                 const fib_prefix_t *prefix,
 392                                 fib_source_t source)
 393 {
 394     /*
 395      * 1 is it present
 396      *   yes => remove source
 397      *    2 - is it still sourced?
 398      *      no => cover walk
 399      */
 400     fib_node_index_t fib_entry_index;
 401     fib_table_t *fib_table;
 402
 403     fib_table = fib_table_get(fib_index, prefix->fp_proto);
 404     fib_entry_index = fib_table_lookup_exact_match_i(fib_table, prefix);
 405
 406     if (FIB_NODE_INDEX_INVALID == fib_entry_index)
 407     {
 408         /*
 409          * removing an etry that does not exist. i'll allow it.
 410          */
 411     }
 412     else
 413     {
 414         fib_entry_src_flag_t src_flag;
 415         int was_sourced;
 416
 417         /*
 418          * don't nobody go nowhere
 419          */
 420         fib_entry_lock(fib_entry_index);
 421         was_sourced = fib_entry_is_sourced(fib_entry_index, source);
 422
 423         src_flag = fib_entry_special_remove(fib_entry_index, source);
 424
 425         if (!(FIB_ENTRY_SRC_FLAG_ADDED & src_flag))
 426         {
 427             /*
 428              * last source gone. remove from the table
 429              */
 430             fib_table_entry_remove(fib_table, prefix, fib_entry_index);
 431
 432             /*
 433              * now the entry is no longer in the table, we can
 434              * inform the entries that it covers to re-calculate their cover
 435              */
 436             fib_entry_cover_change_notify(fib_entry_index,
 437                                           FIB_NODE_INDEX_INVALID);
 438         }
 439         /*
 440          * else
 441          *   still has sources, leave it be.
 442          */
 443         if (was_sourced != fib_entry_is_sourced(fib_entry_index, source))
 444         {
 445             fib_table->ft_src_route_counts[source]--;
 446         }
 447
 448         fib_entry_unlock(fib_entry_index);
 449     }
 450 }
 451
 452 /**
 453  * fib_table_route_path_fixup
 454  *
 455  * Convert attached hosts to attached next-hops.
 456  *
 457  * This special case is required because an attached path will link to a
 458  * glean, and the FIB entry will have the interface or API/CLI source. When
 459  * the ARP/ND process is completes then that source (which will provide a
 460  * complete adjacency) will be lower priority and so the FIB entry will
 461  * remain linked to a glean and traffic will never reach the hosts. For
 462  * an ATTAHCED_HOST path we can link the path directly to the [incomplete]
 463  * adjacency.
 464  */
 465 static void
 466 fib_table_route_path_fixup (const fib_prefix_t *prefix,
 467                             fib_entry_flag_t eflags,
 468                             fib_route_path_t *path)
 469 {
 470     /*
 471      * not all zeros next hop &&
 472      * is recursive path &&
 473      * nexthop is same as the route's address
 474      */
 475     if ((!ip46_address_is_zero(&path->frp_addr)) &&
 476         (~0 == path->frp_sw_if_index) &&
 477         (0 == ip46_address_cmp(&path->frp_addr, &prefix->fp_addr)))
 478     {
 479         /* Prefix recurses via itse;f */
 480         path->frp_flags |= FIB_ROUTE_PATH_DROP;
 481     }
 482     if (fib_prefix_is_host(prefix) &&
 483         ip46_address_is_zero(&path->frp_addr) &&
 484         path->frp_sw_if_index != ~0)
 485     {
 486         path->frp_addr = prefix->fp_addr;
 487         path->frp_flags |= FIB_ROUTE_PATH_ATTACHED;
 488     }
 489     if (eflags & FIB_ENTRY_FLAG_DROP)
 490     {
 491         path->frp_flags |= FIB_ROUTE_PATH_DROP;
 492     }
 493     if (eflags & FIB_ENTRY_FLAG_LOCAL)
 494     {
 495         path->frp_flags |= FIB_ROUTE_PATH_LOCAL;
 496     }
 497     if (eflags & FIB_ENTRY_FLAG_EXCLUSIVE)
 498     {
 499         path->frp_flags |= FIB_ROUTE_PATH_EXCLUSIVE;
 500     }
 501 }
 502
 503 fib_node_index_t
 504 fib_table_entry_path_add (u32 fib_index,
 505                           const fib_prefix_t *prefix,
 506                           fib_source_t source,
 507                           fib_entry_flag_t flags,
 508                           dpo_proto_t next_hop_proto,
 509                           const ip46_address_t *next_hop,
 510                           u32 next_hop_sw_if_index,
 511                           u32 next_hop_fib_index,
 512                           u32 next_hop_weight,
 513                           mpls_label_t *next_hop_labels,
 514                           fib_route_path_flags_t path_flags)
 515 {
 516     fib_route_path_t path = {
 517         .frp_proto = next_hop_proto,
 518         .frp_addr = (NULL == next_hop? zero_addr : *next_hop),
 519         .frp_sw_if_index = next_hop_sw_if_index,
 520         .frp_fib_index = next_hop_fib_index,
 521         .frp_weight = next_hop_weight,
 522         .frp_flags = path_flags,
 523         .frp_label_stack = next_hop_labels,
 524     };
 525     fib_node_index_t fib_entry_index;
 526     fib_route_path_t *paths = NULL;
 527
 528     vec_add1(paths, path);
 529
 530     fib_entry_index = fib_table_entry_path_add2(fib_index, prefix,
 531                                                 source, flags, paths);
 532
 533     vec_free(paths);
 534     return (fib_entry_index);
 535 }
 536
 537 fib_node_index_t
 538 fib_table_entry_path_add2 (u32 fib_index,
 539                            const fib_prefix_t *prefix,
 540                            fib_source_t source,
 541                            fib_entry_flag_t flags,
 542                            fib_route_path_t *rpath)
 543 {
 544     fib_node_index_t fib_entry_index;
 545     fib_table_t *fib_table;
 546     u32 ii;
 547
 548     fib_table = fib_table_get(fib_index, prefix->fp_proto);
 549     fib_entry_index = fib_table_lookup_exact_match_i(fib_table, prefix);
 550
 551     for (ii = 0; ii < vec_len(rpath); ii++)
 552     {
 553         fib_table_route_path_fixup(prefix, flags, &rpath[ii]);
 554     }
 555
 556     if (FIB_NODE_INDEX_INVALID == fib_entry_index)
 557     {
 558         fib_entry_index = fib_entry_create(fib_index, prefix,
 559                                            source, flags,
 560                                            rpath);
 561
 562         fib_table_entry_insert(fib_table, prefix, fib_entry_index);
 563         fib_table->ft_src_route_counts[source]++;
 564     }
 565     else
 566     {
 567         int was_sourced;
 568
 569         was_sourced = fib_entry_is_sourced(fib_entry_index, source);
 570         fib_entry_path_add(fib_entry_index, source, flags, rpath);;
 571
 572         if (was_sourced != fib_entry_is_sourced(fib_entry_index, source))
 573         {
 574             fib_table->ft_src_route_counts[source]++;
 575         }
 576     }
 577
 578     return (fib_entry_index);
 579 }
 580
 581 void
 582 fib_table_entry_path_remove2 (u32 fib_index,
 583                               const fib_prefix_t *prefix,
 584                               fib_source_t source,
 585                               fib_route_path_t *rpath)
 586 {
 587     /*
 588      * 1 is it present
 589      *   yes => remove source
 590      *    2 - is it still sourced?
 591      *      no => cover walk
 592      */
 593     fib_node_index_t fib_entry_index;
 594     fib_table_t *fib_table;
 595     u32 ii;
 596
 597     fib_table = fib_table_get(fib_index, prefix->fp_proto);
 598     fib_entry_index = fib_table_lookup_exact_match_i(fib_table, prefix);
 599
 600     if (FIB_NODE_INDEX_INVALID == fib_entry_index)
 601     {
 602         /*
 603          * removing an etry that does not exist. i'll allow it.
 604          */
 605     }
 606     else
 607     {
 608         fib_entry_src_flag_t src_flag;
 609         int was_sourced;
 610
 611         /*
 612          * if it's not sourced, then there's nowt to remove
 613          */
 614         was_sourced = fib_entry_is_sourced(fib_entry_index, source);
 615         if (!was_sourced)
 616         {
 617             return;
 618         }
 619
 620         /*
 621          * don't nobody go nowhere
 622          */
 623         fib_entry_lock(fib_entry_index);
 624
 625         for (ii = 0; ii < vec_len(rpath); ii++)
 626         {
 627             fib_table_route_path_fixup(
 628                 prefix,
 629                 fib_entry_get_flags_for_source(fib_entry_index,
 630                                                source),
 631                 &rpath[ii]);
 632         }
 633
 634         src_flag = fib_entry_path_remove(fib_entry_index, source, rpath);
 635
 636         if (!(FIB_ENTRY_SRC_FLAG_ADDED & src_flag))
 637         {
 638             /*
 639              * last source gone. remove from the table
 640              */
 641             fib_table_entry_remove(fib_table, prefix, fib_entry_index);
 642
 643             /*
 644              * now the entry is no longer in the table, we can
 645              * inform the entries that it covers to re-calculate their cover
 646              */
 647             fib_entry_cover_change_notify(fib_entry_index,
 648                                           FIB_NODE_INDEX_INVALID);
 649         }
 650         /*
 651          * else
 652          *   still has sources, leave it be.
 653          */
 654         if (was_sourced != fib_entry_is_sourced(fib_entry_index, source))
 655         {
 656             fib_table->ft_src_route_counts[source]--;
 657         }
 658
 659         fib_entry_unlock(fib_entry_index);
 660     }
 661 }
 662
 663 void
 664 fib_table_entry_path_remove (u32 fib_index,
 665                              const fib_prefix_t *prefix,
 666                              fib_source_t source,
 667                              dpo_proto_t next_hop_proto,
 668                              const ip46_address_t *next_hop,
 669                              u32 next_hop_sw_if_index,
 670                              u32 next_hop_fib_index,
 671                              u32 next_hop_weight,
 672                              fib_route_path_flags_t path_flags)
 673 {
 674     /*
 675      * 1 is it present
 676      *   yes => remove source
 677      *    2 - is it still sourced?
 678      *      no => cover walk
 679      */
 680     fib_route_path_t path = {
 681         .frp_proto = next_hop_proto,
 682         .frp_addr = (NULL == next_hop? zero_addr : *next_hop),
 683         .frp_sw_if_index = next_hop_sw_if_index,
 684         .frp_fib_index = next_hop_fib_index,
 685         .frp_weight = next_hop_weight,
 686         .frp_flags = path_flags,
 687     };
 688     fib_route_path_t *paths = NULL;
 689
 690     vec_add1(paths, path);
 691
 692     fib_table_entry_path_remove2(fib_index, prefix, source, paths);
 693
 694     vec_free(paths);
 695 }
 696
 697 static int
 698 fib_route_path_cmp_for_sort (void * v1,
 699                              void * v2)
 700 {
 701     return (fib_route_path_cmp(v1, v2));
 702 }
 703
 704 fib_node_index_t
 705 fib_table_entry_update (u32 fib_index,
 706                         const fib_prefix_t *prefix,
 707                         fib_source_t source,
 708                         fib_entry_flag_t flags,
 709                         fib_route_path_t *paths)
 710 {
 711     fib_node_index_t fib_entry_index;
 712     fib_table_t *fib_table;
 713     u32 ii;
 714
 715     fib_table = fib_table_get(fib_index, prefix->fp_proto);
 716     fib_entry_index = fib_table_lookup_exact_match_i(fib_table, prefix);
 717
 718     for (ii = 0; ii < vec_len(paths); ii++)
 719     {
 720         fib_table_route_path_fixup(prefix, flags, &paths[ii]);
 721     }
 722     /*
 723      * sort the paths provided by the control plane. this means
 724      * the paths and the extension on the entry will be sorted.
 725      */
 726     vec_sort_with_function(paths, fib_route_path_cmp_for_sort);
 727
 728     if (FIB_NODE_INDEX_INVALID == fib_entry_index)
 729     {
 730         fib_entry_index = fib_entry_create(fib_index, prefix,
 731                                            source, flags,
 732                                            paths);
 733
 734         fib_table_entry_insert(fib_table, prefix, fib_entry_index);
 735         fib_table->ft_src_route_counts[source]++;
 736     }
 737     else
 738     {
 739         int was_sourced;
 740
 741         was_sourced = fib_entry_is_sourced(fib_entry_index, source);
 742         fib_entry_update(fib_entry_index, source, flags, paths);
 743
 744         if (was_sourced != fib_entry_is_sourced(fib_entry_index, source))
 745         {
 746             fib_table->ft_src_route_counts[source]++;
 747         }
 748     }
 749
 750     return (fib_entry_index);
 751 }
 752
 753 fib_node_index_t
 754 fib_table_entry_update_one_path (u32 fib_index,
 755                                  const fib_prefix_t *prefix,
 756                                  fib_source_t source,
 757                                  fib_entry_flag_t flags,
 758                                  dpo_proto_t next_hop_proto,
 759                                  const ip46_address_t *next_hop,
 760                                  u32 next_hop_sw_if_index,
 761                                  u32 next_hop_fib_index,
 762                                  u32 next_hop_weight,
 763                                  mpls_label_t *next_hop_labels,
 764                                  fib_route_path_flags_t path_flags)
 765 {
 766     fib_node_index_t fib_entry_index;
 767     fib_route_path_t path = {
 768         .frp_proto = next_hop_proto,
 769         .frp_addr = (NULL == next_hop? zero_addr : *next_hop),
 770         .frp_sw_if_index = next_hop_sw_if_index,
 771         .frp_fib_index = next_hop_fib_index,
 772         .frp_weight = next_hop_weight,
 773         .frp_flags = path_flags,
 774         .frp_label_stack = next_hop_labels,
 775     };
 776     fib_route_path_t *paths = NULL;
 777
 778     vec_add1(paths, path);
 779
 780     fib_entry_index =
 781         fib_table_entry_update(fib_index, prefix, source, flags, paths);
 782
 783     vec_free(paths);
 784
 785     return (fib_entry_index);
 786 }
 787
 788 static void
 789 fib_table_entry_delete_i (u32 fib_index,
 790                           fib_node_index_t fib_entry_index,
 791                           const fib_prefix_t *prefix,
 792                           fib_source_t source)
 793 {
 794     fib_entry_src_flag_t src_flag;
 795     fib_table_t *fib_table;
 796     int was_sourced;
 797
 798     fib_table = fib_table_get(fib_index, prefix->fp_proto);
 799     was_sourced = fib_entry_is_sourced(fib_entry_index, source);
 800
 801     /*
 802      * don't nobody go nowhere
 803      */
 804     fib_entry_lock(fib_entry_index);
 805
 806     src_flag = fib_entry_delete(fib_entry_index, source);
 807
 808     if (!(FIB_ENTRY_SRC_FLAG_ADDED & src_flag))
 809     {
 810         /*
 811          * last source gone. remove from the table
 812          */
 813         fib_table_entry_remove(fib_table, prefix, fib_entry_index);
 814
 815         /*
 816          * now the entry is no longer in the table, we can
 817          * inform the entries that it covers to re-calculate their cover
 818          */
 819         fib_entry_cover_change_notify(fib_entry_index,
 820                                       FIB_NODE_INDEX_INVALID);
 821     }
 822     /*
 823      * else
 824      *   still has sources, leave it be.
 825      */
 826     if (was_sourced != fib_entry_is_sourced(fib_entry_index, source))
 827     {
 828         fib_table->ft_src_route_counts[source]--;
 829     }
 830
 831     fib_entry_unlock(fib_entry_index);
 832 }
 833
 834 void
 835 fib_table_entry_delete (u32 fib_index,
 836                         const fib_prefix_t *prefix,
 837                         fib_source_t source)
 838 {
 839     fib_node_index_t fib_entry_index;
 840
 841     fib_entry_index = fib_table_lookup_exact_match(fib_index, prefix);
 842
 843     if (FIB_NODE_INDEX_INVALID == fib_entry_index)
 844     {
 845         /*
 846          * removing an etry that does not exist.
 847          * i'll allow it, but i won't like it.
 848          */
 849         clib_warning("%U not in FIB", format_fib_prefix, prefix);
 850     }
 851     else
 852     {
 853         fib_table_entry_delete_i(fib_index, fib_entry_index, prefix, source);
 854     }
 855 }
 856
 857 void
 858 fib_table_entry_delete_index (fib_node_index_t fib_entry_index,
 859                               fib_source_t source)
 860 {
 861     fib_prefix_t prefix;
 862
 863     fib_entry_get_prefix(fib_entry_index, &prefix);
 864
 865     fib_table_entry_delete_i(fib_entry_get_fib_index(fib_entry_index),
 866                              fib_entry_index, &prefix, source);
 867 }
 868
 869 fib_node_index_t
 870 fib_table_entry_local_label_add (u32 fib_index,
 871                                  const fib_prefix_t *prefix,
 872                                  mpls_label_t label)
 873 {
 874     fib_node_index_t fib_entry_index;
 875
 876     fib_entry_index = fib_table_lookup_exact_match(fib_index, prefix);
 877
 878     if (FIB_NODE_INDEX_INVALID == fib_entry_index ||
 879         !fib_entry_is_sourced(fib_entry_index, FIB_SOURCE_MPLS))
 880     {
 881         /*
 882          * only source the prefix once. this allows the label change
 883          * operation to work
 884          */
 885         fib_entry_index = fib_table_entry_special_dpo_add(fib_index, prefix,
 886                                                           FIB_SOURCE_MPLS,
 887                                                           FIB_ENTRY_FLAG_NONE,
 888                                                           NULL);
 889     }
 890
 891     fib_entry_set_source_data(fib_entry_index, FIB_SOURCE_MPLS, &label);
 892
 893     return (fib_entry_index);
 894 }
 895
 896 void
 897 fib_table_entry_local_label_remove (u32 fib_index,
 898                                     const fib_prefix_t *prefix,
 899                                     mpls_label_t label)
 900 {
 901     fib_node_index_t fib_entry_index;
 902     const void *data;
 903     mpls_label_t pl;
 904
 905     fib_entry_index = fib_table_lookup_exact_match(fib_index, prefix);
 906
 907     if (FIB_NODE_INDEX_INVALID == fib_entry_index)
 908         return;
 909
 910     data = fib_entry_get_source_data(fib_entry_index, FIB_SOURCE_MPLS);
 911
 912     if (NULL == data)
 913         return;
 914
 915     pl = *(mpls_label_t*)data;
 916
 917     if (pl != label)
 918         return;
 919
 920     pl = MPLS_LABEL_INVALID;
 921
 922     fib_entry_set_source_data(fib_entry_index, FIB_SOURCE_MPLS, &pl);
 923     fib_table_entry_special_remove(fib_index,
 924                                    prefix,
 925                                    FIB_SOURCE_MPLS);
 926 }
 927
 928 u32
 929 fib_table_get_index_for_sw_if_index (fib_protocol_t proto,
 930                                      u32 sw_if_index)
 931 {
 932     switch (proto)
 933     {
 934     case FIB_PROTOCOL_IP4:
 935         return (ip4_fib_table_get_index_for_sw_if_index(sw_if_index));
 936     case FIB_PROTOCOL_IP6:
 937         return (ip6_fib_table_get_index_for_sw_if_index(sw_if_index));
 938     case FIB_PROTOCOL_MPLS:
 939         return (mpls_fib_table_get_index_for_sw_if_index(sw_if_index));
 940     }
 941     return (~0);
 942 }
 943
 944 flow_hash_config_t
 945 fib_table_get_flow_hash_config (u32 fib_index,
 946                                 fib_protocol_t proto)
 947 {
 948     fib_table_t *fib;
 949
 950     fib = fib_table_get(fib_index, proto);
 951
 952     return (fib->ft_flow_hash_config);
 953 }
 954 flow_hash_config_t
 955 fib_table_get_default_flow_hash_config (fib_protocol_t proto)
 956 {
 957     switch (proto)
 958     {
 959     case FIB_PROTOCOL_IP4:
 960     case FIB_PROTOCOL_IP6:
 961         return (IP_FLOW_HASH_DEFAULT);
 962
 963     case FIB_PROTOCOL_MPLS:
 964         return (MPLS_FLOW_HASH_DEFAULT);
 965     }
 966
 967     ASSERT(0);
 968     return (IP_FLOW_HASH_DEFAULT);
 969 }
 970
 971 /**
 972  * @brief Table set flow hash config context.
 973  */
 974 typedef struct fib_table_set_flow_hash_config_ctx_t_
 975 {
 976     /**
 977      * the flow hash config to set
 978      */
 979     flow_hash_config_t hash_config;
 980 } fib_table_set_flow_hash_config_ctx_t;
 981
 982 static int
 983 fib_table_set_flow_hash_config_cb (fib_node_index_t fib_entry_index,
 984                                    void *arg)
 985 {
 986     fib_table_set_flow_hash_config_ctx_t *ctx = arg;
 987
 988     fib_entry_set_flow_hash_config(fib_entry_index, ctx->hash_config);
 989
 990     return (1);
 991 }
 992
 993 void
 994 fib_table_set_flow_hash_config (u32 fib_index,
 995                                 fib_protocol_t proto,
 996                                 flow_hash_config_t hash_config)
 997 {
 998     fib_table_set_flow_hash_config_ctx_t ctx = {
 999         .hash_config = hash_config,
1000     };
1001     fib_table_t *fib;
1002
1003     fib = fib_table_get(fib_index, proto);
1004     fib->ft_flow_hash_config = hash_config;
1005
1006     fib_table_walk(fib_index, proto,
1007                    fib_table_set_flow_hash_config_cb,
1008                    &ctx);
1009 }
1010
1011 u32
1012 fib_table_get_table_id_for_sw_if_index (fib_protocol_t proto,
1013                                         u32 sw_if_index)
1014 {
1015     fib_table_t *fib_table;
1016
1017     fib_table = fib_table_get(fib_table_get_index_for_sw_if_index(
1018                                   proto, sw_if_index),
1019                               proto);
1020
1021     return ((NULL != fib_table ? fib_table->ft_table_id : ~0));
1022 }
1023
1024 u32
1025 fib_table_find (fib_protocol_t proto,
1026                 u32 table_id)
1027 {
1028     switch (proto)
1029     {
1030     case FIB_PROTOCOL_IP4:
1031         return (ip4_fib_index_from_table_id(table_id));
1032     case FIB_PROTOCOL_IP6:
1033         return (ip6_fib_index_from_table_id(table_id));
1034     case FIB_PROTOCOL_MPLS:
1035         return (mpls_fib_index_from_table_id(table_id));
1036     }
1037     return (~0);
1038 }
1039
1040 u32
1041 fib_table_find_or_create_and_lock (fib_protocol_t proto,
1042                                    u32 table_id,
1043                                    fib_source_t src)
1044 {
1045     fib_table_t *fib_table;
1046     fib_node_index_t fi;
1047
1048     switch (proto)
1049     {
1050     case FIB_PROTOCOL_IP4:
1051         fi = ip4_fib_table_find_or_create_and_lock(table_id, src);
1052         break;
1053     case FIB_PROTOCOL_IP6:
1054         fi = ip6_fib_table_find_or_create_and_lock(table_id, src);
1055         break;
1056     case FIB_PROTOCOL_MPLS:
1057         fi = mpls_fib_table_find_or_create_and_lock(table_id, src);
1058         break;
1059     default:
1060         return (~0);
1061     }
1062
1063     fib_table = fib_table_get(fi, proto);
1064
1065     fib_table->ft_desc = format(NULL, "%U-VRF:%d",
1066                                 format_fib_protocol, proto,
1067                                 table_id);
1068
1069     return (fi);
1070 }
1071
1072 u32
1073 fib_table_create_and_lock (fib_protocol_t proto,
1074                            fib_source_t src,
1075                            const char *const fmt,
1076                            ...)
1077 {
1078     fib_table_t *fib_table;
1079     fib_node_index_t fi;
1080     va_list ap;
1081
1082     va_start(ap, fmt);
1083
1084     switch (proto)
1085     {
1086     case FIB_PROTOCOL_IP4:
1087         fi = ip4_fib_table_create_and_lock(src);
1088         break;
1089     case FIB_PROTOCOL_IP6:
1090         fi = ip6_fib_table_create_and_lock(src);
1091         break;
1092      case FIB_PROTOCOL_MPLS:
1093         fi = mpls_fib_table_create_and_lock(src);
1094         break;
1095    default:
1096         return (~0);
1097     }
1098
1099     fib_table = fib_table_get(fi, proto);
1100
1101     fib_table->ft_desc = va_format(fib_table->ft_desc, fmt, &ap);
1102
1103     va_end(ap);
1104     return (fi);
1105 }
1106
1107 static void
1108 fib_table_destroy (fib_table_t *fib_table)
1109 {
1110     vec_free(fib_table->ft_desc);
1111
1112     switch (fib_table->ft_proto)
1113     {
1114     case FIB_PROTOCOL_IP4:
1115         ip4_fib_table_destroy(fib_table->ft_index);
1116         break;
1117     case FIB_PROTOCOL_IP6:
1118         ip6_fib_table_destroy(fib_table->ft_index);
1119         break;
1120     case FIB_PROTOCOL_MPLS:
1121         mpls_fib_table_destroy(fib_table->ft_index);
1122         break;
1123     }
1124 }
1125
1126 void
1127 fib_table_walk (u32 fib_index,
1128                 fib_protocol_t proto,
1129                 fib_table_walk_fn_t fn,
1130                 void *ctx)
1131 {
1132     switch (proto)
1133     {
1134     case FIB_PROTOCOL_IP4:
1135         ip4_fib_table_walk(ip4_fib_get(fib_index), fn, ctx);
1136         break;
1137     case FIB_PROTOCOL_IP6:
1138         ip6_fib_table_walk(fib_index, fn, ctx);
1139         break;
1140     case FIB_PROTOCOL_MPLS:
1141         mpls_fib_table_walk(mpls_fib_get(fib_index), fn, ctx);
1142         break;
1143     }
1144 }
1145
1146 void
1147 fib_table_unlock (u32 fib_index,
1148                   fib_protocol_t proto,
1149                   fib_source_t source)
1150 {
1151     fib_table_t *fib_table;
1152
1153     fib_table = fib_table_get(fib_index, proto);
1154     fib_table->ft_locks[source]--;
1155     fib_table->ft_locks[FIB_TABLE_TOTAL_LOCKS]--;
1156
1157     if (0 == fib_table->ft_locks[source])
1158     {
1159         /*
1160          * The source no longer needs the table. flush any routes
1161          * from it just in case
1162          */
1163         fib_table_flush(fib_index, proto, source);
1164     }
1165
1166     if (0 == fib_table->ft_locks[FIB_TABLE_TOTAL_LOCKS])
1167     {
1168         /*
1169          * no more locak from any source - kill it
1170          */
1171         fib_table_destroy(fib_table);
1172     }
1173 }
1174
1175 void
1176 fib_table_lock (u32 fib_index,
1177                 fib_protocol_t proto,
1178                 fib_source_t source)
1179 {
1180     fib_table_t *fib_table;
1181
1182     fib_table = fib_table_get(fib_index, proto);
1183     fib_table->ft_locks[source]++;
1184     fib_table->ft_locks[FIB_TABLE_TOTAL_LOCKS]++;
1185 }
1186
1187 u32
1188 fib_table_get_num_entries (u32 fib_index,
1189                            fib_protocol_t proto,
1190                            fib_source_t source)
1191 {
1192     fib_table_t *fib_table;
1193
1194     fib_table = fib_table_get(fib_index, proto);
1195
1196     return (fib_table->ft_src_route_counts[source]);
1197 }
1198
1199 u8*
1200 format_fib_table_name (u8* s, va_list ap)
1201 {
1202     fib_node_index_t fib_index = va_arg(ap, fib_node_index_t);
1203     fib_protocol_t proto = va_arg(ap, int); // int promotion
1204     fib_table_t *fib_table;
1205
1206     fib_table = fib_table_get(fib_index, proto);
1207
1208     s = format(s, "%v", fib_table->ft_desc);
1209
1210     return (s);
1211 }
1212
1213 /**
1214  * @brief Table flush context. Store the indicies of matching FIB entries
1215  * that need to be removed.
1216  */
1217 typedef struct fib_table_flush_ctx_t_
1218 {
1219     /**
1220      * The list of entries to flush
1221      */
1222     fib_node_index_t *ftf_entries;
1223
1224     /**
1225      * The source we are flushing
1226      */
1227     fib_source_t ftf_source;
1228 } fib_table_flush_ctx_t;
1229
1230 static int
1231 fib_table_flush_cb (fib_node_index_t fib_entry_index,
1232                     void *arg)
1233 {
1234     fib_table_flush_ctx_t *ctx = arg;
1235
1236     if (fib_entry_is_sourced(fib_entry_index, ctx->ftf_source))
1237     {
1238         vec_add1(ctx->ftf_entries, fib_entry_index);
1239     }
1240     return (1);
1241 }
1242
1243
1244 void
1245 fib_table_flush (u32 fib_index,
1246                  fib_protocol_t proto,
1247                  fib_source_t source)
1248 {
1249     fib_node_index_t *fib_entry_index;
1250     fib_table_flush_ctx_t ctx = {
1251         .ftf_entries = NULL,
1252         .ftf_source = source,
1253     };
1254
1255     fib_table_walk(fib_index, proto,
1256                    fib_table_flush_cb,
1257                    &ctx);
1258
1259     vec_foreach(fib_entry_index, ctx.ftf_entries)
1260     {
1261         fib_table_entry_delete_index(*fib_entry_index, source);
1262     }
1263
1264     vec_free(ctx.ftf_entries);
1265 }