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