src/vnet/adj/adj.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/adj/adj.h>
  17 #include <vnet/adj/adj_internal.h>
  18 #include <vnet/adj/adj_glean.h>
  19 #include <vnet/adj/adj_midchain.h>
  20 #include <vnet/adj/adj_mcast.h>
  21 #include <vnet/adj/adj_delegate.h>
  22 #include <vnet/fib/fib_node_list.h>
  23
  24 /* Adjacency packet/byte counters indexed by adjacency index. */
  25 vlib_combined_counter_main_t adjacency_counters;
  26
  27 /*
  28  * the single adj pool
  29  */
  30 ip_adjacency_t *adj_pool;
  31
  32 /**
  33  * @brief Global Config for enabling per-adjacency counters.
  34  * By default these are disabled.
  35  */
  36 int adj_per_adj_counters;
  37
  38 always_inline void
  39 adj_poison (ip_adjacency_t * adj)
  40 {
  41     if (CLIB_DEBUG > 0)
  42     {
  43         memset (adj, 0xfe, sizeof (adj[0]));
  44     }
  45 }
  46
  47 ip_adjacency_t *
  48 adj_alloc (fib_protocol_t proto)
  49 {
  50     ip_adjacency_t *adj;
  51
  52     pool_get_aligned(adj_pool, adj, CLIB_CACHE_LINE_BYTES);
  53
  54     adj_poison(adj);
  55
  56     /* Make sure certain fields are always initialized. */
  57     /* Validate adjacency counters. */
  58     vlib_validate_combined_counter(&adjacency_counters,
  59                                    adj_get_index(adj));
  60
  61     fib_node_init(&adj->ia_node,
  62                   FIB_NODE_TYPE_ADJ);
  63
  64     adj->ia_nh_proto = proto;
  65     adj->ia_flags = 0;
  66     adj->rewrite_header.sw_if_index = ~0;
  67     adj->rewrite_header.flags = 0;
  68     adj->lookup_next_index = 0;
  69     adj->ia_delegates = NULL;
  70
  71     /* lest it become a midchain in the future */
  72     memset(&adj->sub_type.midchain.next_dpo, 0,
  73            sizeof(adj->sub_type.midchain.next_dpo));
  74
  75     return (adj);
  76 }
  77
  78 static int
  79 adj_index_is_special (adj_index_t adj_index)
  80 {
  81     if (ADJ_INDEX_INVALID == adj_index)
  82         return (!0);
  83
  84     return (0);
  85 }
  86
  87 /**
  88  * @brief Pretty print helper function for formatting specific adjacencies.
  89  * @param s - input string to format
  90  * @param args - other args passed to format function such as:
  91  *                 - vnet_main_t
  92  *                 - ip_lookup_main_t
  93  *                 - adj_index
  94  */
  95 u8 *
  96 format_ip_adjacency (u8 * s, va_list * args)
  97 {
  98     format_ip_adjacency_flags_t fiaf;
  99     ip_adjacency_t * adj;
 100     u32 adj_index;
 101
 102     adj_index = va_arg (*args, u32);
 103     fiaf = va_arg (*args, format_ip_adjacency_flags_t);
 104     adj = adj_get(adj_index);
 105
 106     switch (adj->lookup_next_index)
 107     {
 108     case IP_LOOKUP_NEXT_REWRITE:
 109         s = format (s, "%U", format_adj_nbr, adj_index, 0);
 110         break;
 111     case IP_LOOKUP_NEXT_ARP:
 112         s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
 113         break;
 114     case IP_LOOKUP_NEXT_GLEAN:
 115         s = format (s, "%U", format_adj_glean, adj_index, 0);
 116         break;
 117     case IP_LOOKUP_NEXT_MIDCHAIN:
 118         s = format (s, "%U", format_adj_midchain, adj_index, 2);
 119         break;
 120     case IP_LOOKUP_NEXT_MCAST:
 121         s = format (s, "%U", format_adj_mcast, adj_index, 0);
 122         break;
 123     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
 124         s = format (s, "%U", format_adj_mcast_midchain, adj_index, 0);
 125         break;
 126     default:
 127         break;
 128     }
 129
 130     if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
 131     {
 132         adj_delegate_type_t adt;
 133         adj_delegate_t *aed;
 134         vlib_counter_t counts;
 135
 136         vlib_get_combined_counter(&adjacency_counters, adj_index, &counts);
 137         s = format (s, "\n counts:[%Ld:%Ld]", counts.packets, counts.bytes);
 138         s = format (s, "\n locks:%d", adj->ia_node.fn_locks);
 139         s = format(s, "\n delegates:\n  ");
 140         FOR_EACH_ADJ_DELEGATE(adj, adt, aed,
 141         {
 142             s = format(s, "  %U\n", format_adj_deletegate, aed);
 143         });
 144
 145         s = format(s, "\n children:\n  ");
 146         s = fib_node_children_format(adj->ia_node.fn_children, s);
 147     }
 148
 149     return s;
 150 }
 151
 152 /*
 153  * adj_last_lock_gone
 154  *
 155  * last lock/reference to the adj has gone, we no longer need it.
 156  */
 157 static void
 158 adj_last_lock_gone (ip_adjacency_t *adj)
 159 {
 160     vlib_main_t * vm = vlib_get_main();
 161
 162     ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
 163     ADJ_DBG(adj, "last-lock-gone");
 164
 165     vlib_worker_thread_barrier_sync (vm);
 166
 167     switch (adj->lookup_next_index)
 168     {
 169     case IP_LOOKUP_NEXT_MIDCHAIN:
 170         dpo_reset(&adj->sub_type.midchain.next_dpo);
 171         /* FALL THROUGH */
 172     case IP_LOOKUP_NEXT_ARP:
 173     case IP_LOOKUP_NEXT_REWRITE:
 174         /*
 175          * complete and incomplete nbr adjs
 176          */
 177         adj_nbr_remove(adj_get_index(adj),
 178                        adj->ia_nh_proto,
 179                        adj->ia_link,
 180                        &adj->sub_type.nbr.next_hop,
 181                        adj->rewrite_header.sw_if_index);
 182         break;
 183     case IP_LOOKUP_NEXT_GLEAN:
 184         adj_glean_remove(adj->ia_nh_proto,
 185                          adj->rewrite_header.sw_if_index);
 186         break;
 187     case IP_LOOKUP_NEXT_MCAST:
 188     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
 189         adj_mcast_remove(adj->ia_nh_proto,
 190                          adj->rewrite_header.sw_if_index);
 191         break;
 192     case IP_LOOKUP_NEXT_DROP:
 193     case IP_LOOKUP_NEXT_PUNT:
 194     case IP_LOOKUP_NEXT_LOCAL:
 195     case IP_LOOKUP_NEXT_ICMP_ERROR:
 196     case IP_LOOKUP_N_NEXT:
 197         /*
 198          * type not stored in any DB from which we need to remove it
 199          */
 200         break;
 201     }
 202
 203     vlib_worker_thread_barrier_release(vm);
 204
 205     fib_node_deinit(&adj->ia_node);
 206     ASSERT(0 == vec_len(adj->ia_delegates));
 207     vec_free(adj->ia_delegates);
 208     pool_put(adj_pool, adj);
 209 }
 210
 211 u32
 212 adj_dpo_get_urpf (const dpo_id_t *dpo)
 213 {
 214     ip_adjacency_t *adj;
 215
 216     adj = adj_get(dpo->dpoi_index);
 217
 218     return (adj->rewrite_header.sw_if_index);
 219 }
 220
 221 void
 222 adj_lock (adj_index_t adj_index)
 223 {
 224     ip_adjacency_t *adj;
 225
 226     if (adj_index_is_special(adj_index))
 227     {
 228         return;
 229     }
 230
 231     adj = adj_get(adj_index);
 232     ASSERT(adj);
 233
 234     ADJ_DBG(adj, "lock");
 235     fib_node_lock(&adj->ia_node);
 236 }
 237
 238 void
 239 adj_unlock (adj_index_t adj_index)
 240 {
 241     ip_adjacency_t *adj;
 242
 243     if (adj_index_is_special(adj_index))
 244     {
 245         return;
 246     }
 247
 248     adj = adj_get(adj_index);
 249     ASSERT(adj);
 250
 251     ADJ_DBG(adj, "unlock");
 252     ASSERT(adj);
 253
 254     fib_node_unlock(&adj->ia_node);
 255 }
 256
 257 u32
 258 adj_child_add (adj_index_t adj_index,
 259                fib_node_type_t child_type,
 260                fib_node_index_t child_index)
 261 {
 262     ASSERT(ADJ_INDEX_INVALID != adj_index);
 263     if (adj_index_is_special(adj_index))
 264     {
 265         return (~0);
 266     }
 267
 268     return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
 269                                adj_index,
 270                                child_type,
 271                                child_index));
 272 }
 273
 274 void
 275 adj_child_remove (adj_index_t adj_index,
 276                   u32 sibling_index)
 277 {
 278     if (adj_index_is_special(adj_index))
 279     {
 280         return;
 281     }
 282
 283     fib_node_child_remove(FIB_NODE_TYPE_ADJ,
 284                           adj_index,
 285                           sibling_index);
 286 }
 287
 288 /*
 289  * Context for the walk to update the cached feture flags.
 290  */
 291 typedef struct adj_feature_update_t_
 292 {
 293     u8 arc;
 294     u8 enable;
 295 } adj_feature_update_ctx_t;
 296
 297 static adj_walk_rc_t
 298 adj_feature_update_walk_cb (adj_index_t ai,
 299                             void *arg)
 300 {
 301     adj_feature_update_ctx_t *ctx = arg;
 302     ip_adjacency_t *adj;
 303
 304     adj = adj_get(ai);
 305
 306     /*
 307      * this ugly mess matches the feature arc that is changing with affected
 308      * adjacencies
 309      */
 310     if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
 311          (VNET_LINK_IP6 == adj->ia_link)) ||
 312         ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
 313          (VNET_LINK_IP4 == adj->ia_link)) ||
 314         ((ctx->arc == mpls_main.output_feature_arc_index) &&
 315          (VNET_LINK_MPLS == adj->ia_link)))
 316     {
 317         if (ctx->enable)
 318             adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
 319         else
 320             adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
 321     }
 322     return (ADJ_WALK_RC_CONTINUE);
 323 }
 324
 325 void
 326 adj_feature_update (u32 sw_if_index,
 327                     u8 arc_index,
 328                     u8 is_enable)
 329 {
 330     /*
 331      * Walk all the adjacencies on the interface to update the cached
 332      * 'has-features' flag
 333      */
 334     adj_feature_update_ctx_t ctx = {
 335         .arc = arc_index,
 336         .enable = is_enable,
 337     };
 338     adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
 339 }
 340
 341 static adj_walk_rc_t
 342 adj_mtu_update_walk_cb (adj_index_t ai,
 343                         void *arg)
 344 {
 345     ip_adjacency_t *adj;
 346
 347     adj = adj_get(ai);
 348
 349     vnet_rewrite_update_mtu (vnet_get_main(),
 350                              &adj->rewrite_header);
 351
 352     return (ADJ_WALK_RC_CONTINUE);
 353 }
 354
 355 static void
 356 adj_sw_mtu_update (vnet_main_t * vnm,
 357                    u32 sw_if_index,
 358                    void *ctx)
 359 {
 360     /*
 361      * Walk all the adjacencies on the interface to update the cached MTU
 362      */
 363     adj_walk (sw_if_index, adj_mtu_update_walk_cb, NULL);
 364 }
 365
 366 void
 367 adj_mtu_update (u32 hw_if_index)
 368 {
 369     /*
 370      * Walk all the SW interfaces on the HW interface to update the cached MTU
 371      */
 372     vnet_hw_interface_walk_sw(vnet_get_main(),
 373                               hw_if_index,
 374                               adj_sw_mtu_update,
 375                               NULL);
 376 }
 377
 378 /**
 379  * @brief Walk the Adjacencies on a given interface
 380  */
 381 void
 382 adj_walk (u32 sw_if_index,
 383           adj_walk_cb_t cb,
 384           void *ctx)
 385 {
 386     /*
 387      * walk all the neighbor adjacencies
 388      */
 389     fib_protocol_t proto;
 390
 391     FOR_EACH_FIB_IP_PROTOCOL(proto)
 392     {
 393         adj_nbr_walk(sw_if_index, proto, cb, ctx);
 394         adj_mcast_walk(sw_if_index, proto, cb, ctx);
 395     }
 396 }
 397
 398 /**
 399  * @brief Return the link type of the adjacency
 400  */
 401 vnet_link_t
 402 adj_get_link_type (adj_index_t ai)
 403 {
 404     const ip_adjacency_t *adj;
 405
 406     adj = adj_get(ai);
 407
 408     return (adj->ia_link);
 409 }
 410
 411 /**
 412  * @brief Return the sw interface index of the adjacency.
 413  */
 414 u32
 415 adj_get_sw_if_index (adj_index_t ai)
 416 {
 417     const ip_adjacency_t *adj;
 418
 419     adj = adj_get(ai);
 420
 421     return (adj->rewrite_header.sw_if_index);
 422 }
 423
 424 /**
 425  * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
 426  * 0 is down, !0 is up.
 427  */
 428 int
 429 adj_is_up (adj_index_t ai)
 430 {
 431     const adj_delegate_t *aed;
 432
 433     aed = adj_delegate_get(adj_get(ai), ADJ_DELEGATE_BFD);
 434
 435     if (NULL == aed)
 436     {
 437         /*
 438          * no BFD tracking - resolved
 439          */
 440         return (!0);
 441     }
 442     else
 443     {
 444         /*
 445          * defer to the state of the BFD tracking
 446          */
 447         return (ADJ_BFD_STATE_UP == aed->ad_bfd_state);
 448     }
 449 }
 450
 451 /**
 452  * @brief Return the rewrite string of the adjacency
 453  */
 454 const u8*
 455 adj_get_rewrite (adj_index_t ai)
 456 {
 457     vnet_rewrite_header_t *rw;
 458     ip_adjacency_t *adj;
 459
 460     adj = adj_get(ai);
 461     rw = &adj->rewrite_header;
 462
 463     ASSERT (rw->data_bytes != 0xfefe);
 464
 465     return (rw->data - rw->data_bytes);
 466 }
 467
 468 static fib_node_t *
 469 adj_get_node (fib_node_index_t index)
 470 {
 471     ip_adjacency_t *adj;
 472
 473     adj = adj_get(index);
 474
 475     return (&adj->ia_node);
 476 }
 477
 478 #define ADJ_FROM_NODE(_node)                                            \
 479     ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
 480
 481 static void
 482 adj_node_last_lock_gone (fib_node_t *node)
 483 {
 484     adj_last_lock_gone(ADJ_FROM_NODE(node));
 485 }
 486
 487 static fib_node_back_walk_rc_t
 488 adj_back_walk_notify (fib_node_t *node,
 489                       fib_node_back_walk_ctx_t *ctx)
 490 {
 491     /*
 492      * Que pasa. yo soj en el final!
 493      */
 494     ASSERT(0);
 495
 496     return (FIB_NODE_BACK_WALK_CONTINUE);
 497 }
 498
 499 /*
 500  * Adjacency's graph node virtual function table
 501  */
 502 static const fib_node_vft_t adj_vft = {
 503     .fnv_get = adj_get_node,
 504     .fnv_last_lock = adj_node_last_lock_gone,
 505     .fnv_back_walk = adj_back_walk_notify,
 506 };
 507
 508 static clib_error_t *
 509 adj_module_init (vlib_main_t * vm)
 510 {
 511     fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
 512
 513     adj_nbr_module_init();
 514     adj_glean_module_init();
 515     adj_midchain_module_init();
 516     adj_mcast_module_init();
 517
 518     return (NULL);
 519 }
 520
 521 VLIB_INIT_FUNCTION (adj_module_init);
 522
 523 static clib_error_t *
 524 adj_show (vlib_main_t * vm,
 525           unformat_input_t * input,
 526           vlib_cli_command_t * cmd)
 527 {
 528     adj_index_t ai = ADJ_INDEX_INVALID;
 529     u32 sw_if_index = ~0;
 530     int summary = 0;
 531
 532     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 533     {
 534         if (unformat (input, "%d", &ai))
 535             ;
 536         else if (unformat (input, "sum"))
 537             summary = 1;
 538         else if (unformat (input, "summary"))
 539             summary = 1;
 540         else if (unformat (input, "%U",
 541                            unformat_vnet_sw_interface, vnet_get_main(),
 542                            &sw_if_index))
 543             ;
 544         else
 545             break;
 546     }
 547
 548     if (summary)
 549     {
 550         vlib_cli_output (vm, "Number of adjacenies: %d", pool_elts(adj_pool));
 551         vlib_cli_output (vm, "Per-adjacency counters: %s",
 552                          (adj_are_counters_enabled() ?
 553                           "enabled":
 554                           "disabled"));
 555     }
 556     else
 557     {
 558         if (ADJ_INDEX_INVALID != ai)
 559         {
 560             if (pool_is_free_index(adj_pool, ai))
 561             {
 562                 vlib_cli_output (vm, "adjacency %d invalid", ai);
 563                 return 0;
 564             }
 565
 566             vlib_cli_output (vm, "[@%d] %U",
 567                              ai,
 568                              format_ip_adjacency,  ai,
 569                              FORMAT_IP_ADJACENCY_DETAIL);
 570         }
 571         else
 572         {
 573             /* *INDENT-OFF* */
 574             pool_foreach_index(ai, adj_pool,
 575             ({
 576                 if (~0 != sw_if_index &&
 577                     sw_if_index != adj_get_sw_if_index(ai))
 578                 {
 579                 }
 580                 else
 581                 {
 582                     vlib_cli_output (vm, "[@%d] %U",
 583                                      ai,
 584                                      format_ip_adjacency, ai,
 585                                      FORMAT_IP_ADJACENCY_NONE);
 586                 }
 587             }));
 588             /* *INDENT-ON* */
 589         }
 590     }
 591     return 0;
 592 }
 593
 594 /*?
 595  * Show all adjacencies.
 596  * @cliexpar
 597  * @cliexstart{sh adj}
 598  * [@0]
 599  * [@1]  glean: loop0
 600  * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 601  * [@3] mpls via 1.0.0.2 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 602  * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 603  * [@5] mpls via 1.0.0.3 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 604  * @cliexend
 605  ?*/
 606 VLIB_CLI_COMMAND (adj_show_command, static) = {
 607     .path = "show adj",
 608     .short_help = "show adj [<adj_index>] [interface] [summary]",
 609     .function = adj_show,
 610 };
 611
 612 /**
 613  * @brief CLI invoked function to enable/disable per-adj counters
 614  */
 615 static clib_error_t *
 616 adj_cli_counters_set (vlib_main_t * vm,
 617                       unformat_input_t * input,
 618                       vlib_cli_command_t * cmd)
 619 {
 620     clib_error_t *error = NULL;
 621     int enable = ~0;
 622
 623     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 624     {
 625         if (unformat (input, "enable"))
 626             enable = 1;
 627         else if (unformat (input, "disable"))
 628             enable = 0;
 629         else
 630             break;
 631     }
 632
 633     if (enable != ~0)
 634     {
 635         /* user requested something sensible */
 636         adj_per_adj_counters = enable;
 637     }
 638     else
 639     {
 640         error = clib_error_return (0, "specify 'enable' or 'disable'");
 641     }
 642
 643     return (error);
 644 }
 645
 646 /*?
 647  * Enabe/disble per-adjacency counters. This is optional because it comes with
 648  * a non-negligible performance cost.
 649  ?*/
 650 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
 651     .path = "adjacency counters",
 652     .short_help = "adjacency counters [enable|disable]",
 653     .function = adj_cli_counters_set,
 654 };