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