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