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