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 void
 212 adj_lock (adj_index_t adj_index)
 213 {
 214     ip_adjacency_t *adj;
 215
 216     if (adj_index_is_special(adj_index))
 217     {
 218         return;
 219     }
 220
 221     adj = adj_get(adj_index);
 222     ASSERT(adj);
 223
 224     ADJ_DBG(adj, "lock");
 225     fib_node_lock(&adj->ia_node);
 226 }
 227
 228 void
 229 adj_unlock (adj_index_t adj_index)
 230 {
 231     ip_adjacency_t *adj;
 232
 233     if (adj_index_is_special(adj_index))
 234     {
 235         return;
 236     }
 237
 238     adj = adj_get(adj_index);
 239     ASSERT(adj);
 240
 241     ADJ_DBG(adj, "unlock");
 242     ASSERT(adj);
 243
 244     fib_node_unlock(&adj->ia_node);
 245 }
 246
 247 u32
 248 adj_child_add (adj_index_t adj_index,
 249                fib_node_type_t child_type,
 250                fib_node_index_t child_index)
 251 {
 252     ASSERT(ADJ_INDEX_INVALID != adj_index);
 253     if (adj_index_is_special(adj_index))
 254     {
 255         return (~0);
 256     }
 257
 258     return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
 259                                adj_index,
 260                                child_type,
 261                                child_index));
 262 }
 263
 264 void
 265 adj_child_remove (adj_index_t adj_index,
 266                   u32 sibling_index)
 267 {
 268     if (adj_index_is_special(adj_index))
 269     {
 270         return;
 271     }
 272
 273     fib_node_child_remove(FIB_NODE_TYPE_ADJ,
 274                           adj_index,
 275                           sibling_index);
 276 }
 277
 278 /*
 279  * Context for the walk to update the cached feture flags.
 280  */
 281 typedef struct adj_feature_update_t_
 282 {
 283     u8 arc;
 284     u8 enable;
 285 } adj_feature_update_ctx_t;
 286
 287 static adj_walk_rc_t
 288 adj_feature_update_walk_cb (adj_index_t ai,
 289                             void *arg)
 290 {
 291     adj_feature_update_ctx_t *ctx = arg;
 292     ip_adjacency_t *adj;
 293
 294     adj = adj_get(ai);
 295
 296     /*
 297      * this ugly mess matches the feature arc that is changing with affected
 298      * adjacencies
 299      */
 300     if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
 301          (VNET_LINK_IP6 == adj->ia_link)) ||
 302         ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
 303          (VNET_LINK_IP4 == adj->ia_link)) ||
 304         ((ctx->arc == mpls_main.output_feature_arc_index) &&
 305          (VNET_LINK_MPLS == adj->ia_link)))
 306     {
 307         if (ctx->enable)
 308             adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
 309         else
 310             adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
 311     }
 312     return (ADJ_WALK_RC_CONTINUE);
 313 }
 314
 315 void
 316 adj_feature_update (u32 sw_if_index,
 317                     u8 arc_index,
 318                     u8 is_enable)
 319 {
 320     /*
 321      * Walk all the adjacencies on the interface to update the cached
 322      * 'has-features' flag
 323      */
 324     adj_feature_update_ctx_t ctx = {
 325         .arc = arc_index,
 326         .enable = is_enable,
 327     };
 328     adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
 329 }
 330
 331 /**
 332  * @brief Walk the Adjacencies on a given interface
 333  */
 334 void
 335 adj_walk (u32 sw_if_index,
 336           adj_walk_cb_t cb,
 337           void *ctx)
 338 {
 339     /*
 340      * walk all the neighbor adjacencies
 341      */
 342     fib_protocol_t proto;
 343
 344     FOR_EACH_FIB_IP_PROTOCOL(proto)
 345     {
 346         adj_nbr_walk(sw_if_index, proto, cb, ctx);
 347         adj_mcast_walk(sw_if_index, proto, cb, ctx);
 348     }
 349 }
 350
 351 /**
 352  * @brief Return the link type of the adjacency
 353  */
 354 vnet_link_t
 355 adj_get_link_type (adj_index_t ai)
 356 {
 357     const ip_adjacency_t *adj;
 358
 359     adj = adj_get(ai);
 360
 361     return (adj->ia_link);
 362 }
 363
 364 /**
 365  * @brief Return the sw interface index of the adjacency.
 366  */
 367 u32
 368 adj_get_sw_if_index (adj_index_t ai)
 369 {
 370     const ip_adjacency_t *adj;
 371
 372     adj = adj_get(ai);
 373
 374     return (adj->rewrite_header.sw_if_index);
 375 }
 376
 377 /**
 378  * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
 379  * 0 is down, !0 is up.
 380  */
 381 int
 382 adj_is_up (adj_index_t ai)
 383 {
 384     const adj_delegate_t *aed;
 385
 386     aed = adj_delegate_get(adj_get(ai), ADJ_DELEGATE_BFD);
 387
 388     if (NULL == aed)
 389     {
 390         /*
 391          * no BFD tracking - resolved
 392          */
 393         return (!0);
 394     }
 395     else
 396     {
 397         /*
 398          * defer to the state of the BFD tracking
 399          */
 400         return (ADJ_BFD_STATE_UP == aed->ad_bfd_state);
 401     }
 402 }
 403
 404 /**
 405  * @brief Return the rewrite string of the adjacency
 406  */
 407 const u8*
 408 adj_get_rewrite (adj_index_t ai)
 409 {
 410     vnet_rewrite_header_t *rw;
 411     ip_adjacency_t *adj;
 412
 413     adj = adj_get(ai);
 414     rw = &adj->rewrite_header;
 415
 416     ASSERT (rw->data_bytes != 0xfefe);
 417
 418     return (rw->data - rw->data_bytes);
 419 }
 420
 421 static fib_node_t *
 422 adj_get_node (fib_node_index_t index)
 423 {
 424     ip_adjacency_t *adj;
 425
 426     adj = adj_get(index);
 427
 428     return (&adj->ia_node);
 429 }
 430
 431 #define ADJ_FROM_NODE(_node)                                            \
 432     ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
 433
 434 static void
 435 adj_node_last_lock_gone (fib_node_t *node)
 436 {
 437     adj_last_lock_gone(ADJ_FROM_NODE(node));
 438 }
 439
 440 static fib_node_back_walk_rc_t
 441 adj_back_walk_notify (fib_node_t *node,
 442                       fib_node_back_walk_ctx_t *ctx)
 443 {
 444     /*
 445      * Que pasa. yo soj en el final!
 446      */
 447     ASSERT(0);
 448
 449     return (FIB_NODE_BACK_WALK_CONTINUE);
 450 }
 451
 452 /*
 453  * Adjacency's graph node virtual function table
 454  */
 455 static const fib_node_vft_t adj_vft = {
 456     .fnv_get = adj_get_node,
 457     .fnv_last_lock = adj_node_last_lock_gone,
 458     .fnv_back_walk = adj_back_walk_notify,
 459 };
 460
 461 static clib_error_t *
 462 adj_module_init (vlib_main_t * vm)
 463 {
 464     fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
 465
 466     adj_nbr_module_init();
 467     adj_glean_module_init();
 468     adj_midchain_module_init();
 469     adj_mcast_module_init();
 470
 471     return (NULL);
 472 }
 473
 474 VLIB_INIT_FUNCTION (adj_module_init);
 475
 476 static clib_error_t *
 477 adj_show (vlib_main_t * vm,
 478           unformat_input_t * input,
 479           vlib_cli_command_t * cmd)
 480 {
 481     adj_index_t ai = ADJ_INDEX_INVALID;
 482     u32 sw_if_index = ~0;
 483     int summary = 0;
 484
 485     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 486     {
 487         if (unformat (input, "%d", &ai))
 488             ;
 489         else if (unformat (input, "sum"))
 490             summary = 1;
 491         else if (unformat (input, "summary"))
 492             summary = 1;
 493         else if (unformat (input, "%U",
 494                            unformat_vnet_sw_interface, vnet_get_main(),
 495                            &sw_if_index))
 496             ;
 497         else
 498             break;
 499     }
 500
 501     if (summary)
 502     {
 503         vlib_cli_output (vm, "Number of adjacenies: %d", pool_elts(adj_pool));
 504         vlib_cli_output (vm, "Per-adjacency counters: %s",
 505                          (adj_are_counters_enabled() ?
 506                           "enabled":
 507                           "disabled"));
 508     }
 509     else
 510     {
 511         if (ADJ_INDEX_INVALID != ai)
 512         {
 513             if (pool_is_free_index(adj_pool, ai))
 514             {
 515                 vlib_cli_output (vm, "adjacency %d invalid", ai);
 516                 return 0;
 517             }
 518
 519             vlib_cli_output (vm, "[@%d] %U",
 520                              ai,
 521                              format_ip_adjacency,  ai,
 522                              FORMAT_IP_ADJACENCY_DETAIL);
 523         }
 524         else
 525         {
 526             /* *INDENT-OFF* */
 527             pool_foreach_index(ai, adj_pool,
 528             ({
 529                 if (~0 != sw_if_index &&
 530                     sw_if_index != adj_get_sw_if_index(ai))
 531                 {
 532                 }
 533                 else
 534                 {
 535                     vlib_cli_output (vm, "[@%d] %U",
 536                                      ai,
 537                                      format_ip_adjacency, ai,
 538                                      FORMAT_IP_ADJACENCY_NONE);
 539                 }
 540             }));
 541             /* *INDENT-ON* */
 542         }
 543     }
 544     return 0;
 545 }
 546
 547 /*?
 548  * Show all adjacencies.
 549  * @cliexpar
 550  * @cliexstart{sh adj}
 551  * [@0]
 552  * [@1]  glean: loop0
 553  * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 554  * [@3] mpls via 1.0.0.2 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 555  * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 556  * [@5] mpls via 1.0.0.3 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 557  * @cliexend
 558  ?*/
 559 VLIB_CLI_COMMAND (adj_show_command, static) = {
 560     .path = "show adj",
 561     .short_help = "show adj [<adj_index>] [interface] [summary]",
 562     .function = adj_show,
 563 };
 564
 565 /**
 566  * @brief CLI invoked function to enable/disable per-adj counters
 567  */
 568 static clib_error_t *
 569 adj_cli_counters_set (vlib_main_t * vm,
 570                       unformat_input_t * input,
 571                       vlib_cli_command_t * cmd)
 572 {
 573     clib_error_t *error = NULL;
 574     int enable = ~0;
 575
 576     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 577     {
 578         if (unformat (input, "enable"))
 579             enable = 1;
 580         else if (unformat (input, "disable"))
 581             enable = 0;
 582         else
 583             break;
 584     }
 585
 586     if (enable != ~0)
 587     {
 588         /* user requested something sensible */
 589         adj_per_adj_counters = enable;
 590     }
 591     else
 592     {
 593         error = clib_error_return (0, "specify 'enable' or 'disable'");
 594     }
 595
 596     return (error);
 597 }
 598
 599 /*?
 600  * Enabe/disble per-adjacency counters. This is optional because it comes with
 601  * a non-negligible performance cost.
 602  ?*/
 603 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
 604     .path = "adjacency counters",
 605     .short_help = "adjacency counters [enable|disable]",
 606     .function = adj_cli_counters_set,
 607 };