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