src/vnet/l2/l2_fib.c

   1 /*
   2  * l2_fib.c : layer 2 forwarding table (aka mac table)
   3  *
   4  * Copyright (c) 2013 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18
  19 #include <vlib/vlib.h>
  20 #include <vnet/vnet.h>
  21 #include <vnet/ethernet/ethernet.h>
  22 #include <vlib/cli.h>
  23
  24 #include <vppinfra/error.h>
  25 #include <vppinfra/hash.h>
  26 #include <vnet/l2/l2_input.h>
  27 #include <vnet/l2/l2_fib.h>
  28 #include <vnet/l2/l2_learn.h>
  29 #include <vnet/l2/l2_bd.h>
  30 #include <vppinfra/bihash_template.c>
  31 #include <vlibmemory/api.h>
  32
  33 #include <vnet/l2/l2.api_enum.h>
  34 #include <vnet/l2/l2.api_types.h>
  35
  36 #define vl_endianfun
  37 #include <vnet/l2/l2.api.h>
  38 #undef vl_endianfun
  39
  40 /**
  41  * @file
  42  * @brief Ethernet MAC Address FIB Table Management.
  43  *
  44  * The MAC Address forwarding table for bridge-domains is called the l2fib.
  45  * Entries are added automatically as part of mac learning, but MAC Addresses
  46  * entries can also be added manually.
  47  *
  48  */
  49
  50 l2fib_main_t l2fib_main;
  51
  52 u8 *
  53 format_l2fib_entry_result_flags (u8 * s, va_list * args)
  54 {
  55   l2fib_entry_result_flags_t flags = va_arg (*args, int);
  56
  57   if (L2FIB_ENTRY_RESULT_FLAG_NONE == flags)
  58     {
  59       s = format (s, "none");
  60     }
  61   else
  62     {
  63 #define _(a,v,t) {                              \
  64       if (flags & L2FIB_ENTRY_RESULT_FLAG_##a)  \
  65         s = format (s, "%s ", t);               \
  66     }
  67       foreach_l2fib_entry_result_attr
  68 #undef _
  69     }
  70   return (s);
  71 }
  72
  73 static void
  74 incr_mac_address (u8 * mac)
  75 {
  76   u64 tmp = *((u64 *) mac);
  77   tmp = clib_net_to_host_u64 (tmp);
  78   tmp += 1 << 16;               /* skip unused (least significant) octets */
  79   tmp = clib_host_to_net_u64 (tmp);
  80
  81   clib_memcpy_fast (mac, &tmp, 6);
  82 }
  83
  84 /** Format sw_if_index. If the value is ~0, use the text "N/A" */
  85 u8 *
  86 format_vnet_sw_if_index_name_with_NA (u8 * s, va_list * args)
  87 {
  88   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
  89   u32 sw_if_index = va_arg (*args, u32);
  90   if (sw_if_index == ~0)
  91     return format (s, "N/A");
  92
  93   vnet_sw_interface_t *swif =
  94     vnet_get_sw_interface_or_null (vnm, sw_if_index);
  95   if (!swif)
  96     return format (s, "Stale");
  97
  98   return format (s, "%U", format_vnet_sw_if_index_name, vnm, sw_if_index);
  99 }
 100
 101 typedef struct l2fib_dump_walk_ctx_t_
 102 {
 103   u32 bd_index;
 104   l2fib_entry_key_t *l2fe_key;
 105   l2fib_entry_result_t *l2fe_res;
 106 } l2fib_dump_walk_ctx_t;
 107
 108 static int
 109 l2fib_dump_walk_cb (BVT (clib_bihash_kv) * kvp, void *arg)
 110 {
 111   l2fib_dump_walk_ctx_t *ctx = arg;
 112   l2fib_entry_result_t result;
 113   l2fib_entry_key_t key;
 114
 115   key.raw = kvp->key;
 116   result.raw = kvp->value;
 117
 118   if ((ctx->bd_index == ~0) || (ctx->bd_index == key.fields.bd_index))
 119     {
 120       vec_add1 (ctx->l2fe_key, key);
 121       vec_add1 (ctx->l2fe_res, result);
 122     }
 123
 124   return (BIHASH_WALK_CONTINUE);
 125 }
 126
 127 void
 128 l2fib_table_dump (u32 bd_index,
 129                   l2fib_entry_key_t ** l2fe_key,
 130                   l2fib_entry_result_t ** l2fe_res)
 131 {
 132   l2fib_main_t *msm = &l2fib_main;
 133   l2fib_dump_walk_ctx_t ctx = {
 134     .bd_index = bd_index,
 135   };
 136
 137   BV (clib_bihash_foreach_key_value_pair)
 138     (&msm->mac_table, l2fib_dump_walk_cb, &ctx);
 139
 140   *l2fe_key = ctx.l2fe_key;
 141   *l2fe_res = ctx.l2fe_res;
 142 }
 143
 144 void
 145 l2_fib_extract_seq_num (l2fib_seq_num_t sn, u8 * bd_sn, u8 * if_sn)
 146 {
 147   *bd_sn = sn >> 8;
 148   *if_sn = sn & 0xff;
 149 }
 150
 151 u8 *
 152 format_l2_fib_seq_num (u8 * s, va_list * a)
 153 {
 154   l2fib_seq_num_t sn = va_arg (*a, int);
 155   u8 bd_sn, if_sn;
 156
 157   l2_fib_extract_seq_num (sn, &bd_sn, &if_sn);
 158
 159   s = format (s, "%3d/%-3d", bd_sn, if_sn);
 160
 161   return (s);
 162 }
 163
 164 typedef struct l2fib_show_walk_ctx_t_
 165 {
 166   u8 first_entry;
 167   u8 verbose;
 168   vlib_main_t *vm;
 169   vnet_main_t *vnm;
 170   u32 total_entries;
 171   u32 bd_index;
 172   u8 learn;
 173   u8 add;
 174   u8 now;
 175 } l2fib_show_walk_ctx_t;
 176
 177 static int
 178 l2fib_show_walk_cb (BVT (clib_bihash_kv) * kvp, void *arg)
 179 {
 180   l2fib_show_walk_ctx_t *ctx = arg;
 181   l2_bridge_domain_t *bd_config;
 182   l2fib_entry_result_t result;
 183   l2fib_entry_key_t key;
 184
 185   if (ctx->verbose && ctx->first_entry)
 186     {
 187       ctx->first_entry = 0;
 188       vlib_cli_output (ctx->vm,
 189                        "%=19s%=7s%=7s%=8s%=9s%=7s%=7s%=5s%=30s",
 190                        "Mac-Address", "BD-Idx", "If-Idx",
 191                        "BSN-ISN", "Age(min)", "static", "filter",
 192                        "bvi", "Interface-Name");
 193     }
 194
 195   key.raw = kvp->key;
 196   result.raw = kvp->value;
 197   ctx->total_entries++;
 198
 199   if (ctx->verbose &&
 200       ((ctx->bd_index >> 31) || (ctx->bd_index == key.fields.bd_index)))
 201     {
 202       u8 *s = NULL;
 203
 204       if (ctx->learn && l2fib_entry_result_is_set_AGE_NOT (&result))
 205         return (BIHASH_WALK_CONTINUE);  /* skip provisioned macs */
 206
 207       if (ctx->add && !l2fib_entry_result_is_set_AGE_NOT (&result))
 208         return (BIHASH_WALK_CONTINUE);  /* skip learned macs */
 209
 210       bd_config = &vec_elt (l2input_main.bd_configs, key.fields.bd_index);
 211
 212       if (l2fib_entry_result_is_set_AGE_NOT (&result))
 213         s = format (s, "no");
 214       else if (bd_config->mac_age == 0)
 215         s = format (s, "-");
 216       else
 217         {
 218           i16 delta = ctx->now - result.fields.timestamp;
 219           delta += delta < 0 ? 256 : 0;
 220           s = format (s, "%d", delta);
 221         }
 222
 223       vlib_cli_output (ctx->vm,
 224                        "%=19U%=7d%=7d %U%=9v%=7s%=7s%=5s%=30U",
 225                        format_ethernet_address, key.fields.mac,
 226                        key.fields.bd_index,
 227                        result.fields.sw_if_index == ~0
 228                        ? -1 : result.fields.sw_if_index,
 229                        format_l2_fib_seq_num, result.fields.sn, s,
 230                        l2fib_entry_result_is_set_STATIC (&result) ? "*" : "-",
 231                        l2fib_entry_result_is_set_FILTER (&result) ? "*" : "-",
 232                        l2fib_entry_result_is_set_BVI (&result) ? "*" : "-",
 233                        format_vnet_sw_if_index_name_with_NA,
 234                        ctx->vnm, result.fields.sw_if_index);
 235       vec_free (s);
 236     }
 237
 238   return (BIHASH_WALK_CONTINUE);
 239 }
 240
 241 /** Display the contents of the l2fib. */
 242 static clib_error_t *
 243 show_l2fib (vlib_main_t * vm,
 244             unformat_input_t * input, vlib_cli_command_t * cmd)
 245 {
 246   bd_main_t *bdm = &bd_main;
 247   l2fib_main_t *msm = &l2fib_main;
 248   u8 raw = 0;
 249   u32 bd_id;
 250   l2fib_show_walk_ctx_t ctx = {
 251     .first_entry = 1,
 252     .bd_index = ~0,
 253     .now = (u8) (vlib_time_now (vm) / 60),
 254     .vm = vm,
 255     .vnm = msm->vnet_main,
 256   };
 257
 258   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 259     {
 260       if (unformat (input, "raw"))
 261         {
 262           raw = 1;
 263           ctx.verbose = 0;
 264           break;
 265         }
 266       else if (unformat (input, "verbose"))
 267         ctx.verbose = 1;
 268       else if (unformat (input, "all"))
 269         ctx.verbose = 1;
 270       else if (unformat (input, "bd_index %d", &ctx.bd_index))
 271         ctx.verbose = 1;
 272       else if (unformat (input, "learn"))
 273         {
 274           ctx.add = 0;
 275           ctx.learn = 1;
 276           ctx.verbose = 1;
 277         }
 278       else if (unformat (input, "add"))
 279         {
 280           ctx.learn = 0;
 281           ctx.add = 1;
 282           ctx.verbose = 1;
 283         }
 284       else if (unformat (input, "bd_id %d", &bd_id))
 285         {
 286           uword *p = hash_get (bdm->bd_index_by_bd_id, bd_id);
 287           if (p)
 288             {
 289               ctx.verbose = 1;
 290               ctx.bd_index = p[0];
 291             }
 292           else
 293             return clib_error_return (0,
 294                                       "bridge domain id %d doesn't exist\n",
 295                                       bd_id);
 296         }
 297       else
 298         break;
 299     }
 300
 301   if (msm->mac_table_initialized == 0)
 302     {
 303       vlib_cli_output (vm, "no l2fib entries");
 304       return 0;
 305     }
 306
 307   BV (clib_bihash_foreach_key_value_pair)
 308     (&msm->mac_table, l2fib_show_walk_cb, &ctx);
 309
 310   if (ctx.total_entries == 0)
 311     vlib_cli_output (vm, "no l2fib entries");
 312   else
 313     {
 314       l2learn_main_t *lm = &l2learn_main;
 315       vlib_cli_output (vm, "L2FIB total/learned entries: %d/%d  "
 316                        "Last scan time: %.4esec  Learn limit: %d ",
 317                        ctx.total_entries, lm->global_learn_count,
 318                        msm->age_scan_duration, lm->global_learn_limit);
 319       if (lm->client_pid)
 320         vlib_cli_output (vm, "L2MAC events client PID: %d  "
 321                          "Last e-scan time: %.4esec  Delay: %.2esec  "
 322                          "Max macs in event: %d",
 323                          lm->client_pid, msm->evt_scan_duration,
 324                          msm->event_scan_delay, msm->max_macs_in_event);
 325     }
 326
 327   if (raw)
 328     vlib_cli_output (vm, "Raw Hash Table:\n%U\n",
 329                      BV (format_bihash), &msm->mac_table, 1 /* verbose */ );
 330
 331   return 0;
 332 }
 333
 334 /*?
 335  * This command displays the MAC Address entries of the L2 FIB table.
 336  * Output can be filtered to just get the number of MAC Addresses or display
 337  * each MAC Address for all bridge domains or just a single bridge domain.
 338  *
 339  * @cliexpar
 340  * Example of how to display the number of MAC Address entries in the L2
 341  * FIB table:
 342  * @cliexstart{show l2fib}
 343  * 3 l2fib entries
 344  * @cliexend
 345  * Example of how to display all the MAC Address entries in the L2
 346  * FIB table:
 347  * @cliexstart{show l2fib all}
 348  *     Mac Address     BD Idx           Interface           Index  static  filter  bvi  refresh  timestamp
 349  *  52:54:00:53:18:33    1      GigabitEthernet0/8/0.200      3       0       0     0      0         0
 350  *  52:54:00:53:18:55    1      GigabitEthernet0/8/0.200      3       1       0     0      0         0
 351  *  52:54:00:53:18:77    1                 N/A                -1      1       1     0      0         0
 352  * 3 l2fib entries
 353  * @cliexend
 354 ?*/
 355 /* *INDENT-OFF* */
 356 VLIB_CLI_COMMAND (show_l2fib_cli, static) = {
 357   .path = "show l2fib",
 358   .short_help = "show l2fib [all] | [bd_id <nn> | bd_index <nn>] [learn | add] | [raw]",
 359   .function = show_l2fib,
 360 };
 361 /* *INDENT-ON* */
 362
 363 void
 364 l2fib_table_init (void)
 365 {
 366   l2fib_main_t *mp = &l2fib_main;
 367
 368   if (mp->mac_table_initialized == 1)
 369     return;
 370
 371   BV (clib_bihash_init) (&mp->mac_table, "l2fib mac table",
 372                          mp->mac_table_n_buckets, mp->mac_table_memory_size);
 373   mp->mac_table_initialized = 1;
 374 }
 375
 376 /* Remove all entries from the l2fib */
 377 void
 378 l2fib_clear_table (void)
 379 {
 380   l2fib_main_t *mp = &l2fib_main;
 381   l2_bridge_domain_t *bd_config;
 382
 383   if (mp->mac_table_initialized == 0)
 384     return;
 385
 386   mp->mac_table_initialized = 0;
 387
 388   /* Remove all entries */
 389   BV (clib_bihash_free) (&mp->mac_table);
 390   l2fib_table_init ();
 391   l2learn_main.global_learn_count = 0;
 392   vec_foreach (bd_config, l2input_main.bd_configs)
 393     bd_config->learn_count = 0;
 394 }
 395
 396 /** Clear all entries in L2FIB.
 397  * @TODO: Later we may want a way to remove only the non-static entries
 398  */
 399 static clib_error_t *
 400 clear_l2fib (vlib_main_t * vm,
 401              unformat_input_t * input, vlib_cli_command_t * cmd)
 402 {
 403   l2fib_clear_table ();
 404   return 0;
 405 }
 406
 407 /*?
 408  * This command clears all the MAC Address entries from the L2 FIB table.
 409  *
 410  * @cliexpar
 411  * Example of how to clear the L2 FIB Table:
 412  * @cliexcmd{clear l2fib}
 413  * Example to show the L2 FIB Table has been cleared:
 414  * @cliexstart{show l2fib verbose}
 415  * no l2fib entries
 416  * @cliexend
 417 ?*/
 418 /* *INDENT-OFF* */
 419 VLIB_CLI_COMMAND (clear_l2fib_cli, static) = {
 420   .path = "clear l2fib",
 421   .short_help = "clear l2fib",
 422   .function = clear_l2fib,
 423 };
 424 /* *INDENT-ON* */
 425
 426 static l2fib_seq_num_t
 427 l2fib_cur_seq_num (u32 bd_index, u32 sw_if_index)
 428 {
 429   l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);
 430
 431   return l2_fib_mk_seq_num (bd_config->seq_num,
 432                             l2_input_seq_num (sw_if_index));
 433 }
 434
 435 /**
 436  * Add an entry to the l2fib.
 437  * If the entry already exists then overwrite it
 438  */
 439 void
 440 l2fib_add_entry (const u8 * mac, u32 bd_index,
 441                  u32 sw_if_index, l2fib_entry_result_flags_t flags)
 442 {
 443   l2fib_entry_key_t key;
 444   l2fib_entry_result_t result;
 445   __attribute__ ((unused)) u32 bucket_contents;
 446   l2fib_main_t *fm = &l2fib_main;
 447   l2learn_main_t *lm = &l2learn_main;
 448   BVT (clib_bihash_kv) kv;
 449
 450   if (fm->mac_table_initialized == 0)
 451     l2fib_table_init ();
 452
 453   /* set up key */
 454   key.raw = l2fib_make_key (mac, bd_index);
 455   kv.key = key.raw;
 456
 457   /* check if entry already exist */
 458   if (BV (clib_bihash_search) (&fm->mac_table, &kv, &kv))
 459     {
 460       /* decrement counter if overwriting a learned mac  */
 461       result.raw = kv.value;
 462       if (!l2fib_entry_result_is_set_AGE_NOT (&result))
 463         {
 464           l2_bridge_domain_t *bd_config =
 465             vec_elt_at_index (l2input_main.bd_configs, bd_index);
 466
 467           /* check if learn_count == 0 in case of race condition between 2
 468            * workers adding an entry simultaneously */
 469           /* learn_count variable may have little inaccuracy because they are
 470            * not incremented/decremented with atomic operations */
 471           /* l2fib_scan is call every 2sec fixing potential inaccuracy */
 472           if (lm->global_learn_count)
 473             lm->global_learn_count--;
 474           if (bd_config->learn_count)
 475             bd_config->learn_count--;
 476         }
 477     }
 478
 479   /* set up result */
 480   result.raw = 0;               /* clear all fields */
 481   result.fields.sw_if_index = sw_if_index;
 482   result.fields.flags = flags;
 483
 484   /* no aging for provisioned entry */
 485   l2fib_entry_result_set_AGE_NOT (&result);
 486
 487   kv.value = result.raw;
 488
 489   BV (clib_bihash_add_del) (&fm->mac_table, &kv, 1 /* is_add */ );
 490 }
 491
 492 /**
 493  * Add an entry to the L2FIB.
 494  * The CLI format is:
 495  *    l2fib add <mac> <bd> <intf> [static] [bvi]
 496  *    l2fib add <mac> <bd> filter
 497  * Note that filter and bvi entries are always static
 498  */
 499 static clib_error_t *
 500 l2fib_add (vlib_main_t * vm,
 501            unformat_input_t * input, vlib_cli_command_t * cmd)
 502 {
 503   bd_main_t *bdm = &bd_main;
 504   vnet_main_t *vnm = vnet_get_main ();
 505   clib_error_t *error = 0;
 506   u8 mac[6];
 507   u32 bd_id;
 508   u32 bd_index;
 509   u32 sw_if_index = ~0;
 510   uword *p;
 511   l2fib_entry_result_flags_t flags;
 512
 513   flags = L2FIB_ENTRY_RESULT_FLAG_NONE;
 514
 515   if (!unformat (input, "%U", unformat_ethernet_address, mac))
 516     {
 517       error = clib_error_return (0, "expected mac address `%U'",
 518                                  format_unformat_error, input);
 519       goto done;
 520     }
 521
 522   if (!unformat (input, "%d", &bd_id))
 523     {
 524       error = clib_error_return (0, "expected bridge domain ID `%U'",
 525                                  format_unformat_error, input);
 526       goto done;
 527     }
 528
 529   p = hash_get (bdm->bd_index_by_bd_id, bd_id);
 530   if (!p)
 531     {
 532       error = clib_error_return (0, "bridge domain ID %d invalid", bd_id);
 533       goto done;
 534     }
 535   bd_index = p[0];
 536
 537   if (unformat (input, "filter"))
 538     {
 539       l2fib_add_filter_entry (mac, bd_index);
 540       return 0;
 541     }
 542
 543   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 544     {
 545       error = clib_error_return (0, "unknown interface `%U'",
 546                                  format_unformat_error, input);
 547       goto done;
 548     }
 549
 550   if (unformat (input, "static"))
 551     flags |= L2FIB_ENTRY_RESULT_FLAG_STATIC;
 552   else if (unformat (input, "bvi"))
 553     flags |= (L2FIB_ENTRY_RESULT_FLAG_STATIC | L2FIB_ENTRY_RESULT_FLAG_BVI);
 554
 555   if (vec_len (l2input_main.configs) <= sw_if_index)
 556     {
 557       error = clib_error_return (0, "Interface sw_if_index %d not in L2 mode",
 558                                  sw_if_index);
 559       goto done;
 560     }
 561
 562   l2fib_add_entry (mac, bd_index, sw_if_index, flags);
 563
 564 done:
 565   return error;
 566 }
 567
 568 /*?
 569  * This command adds a MAC Address entry to the L2 FIB table
 570  * of an existing bridge-domain. The MAC Address can be static
 571  * or dynamic. This command also allows a filter to be added,
 572  * such that packets with given MAC Addresses (source mac or
 573  * destination mac match) are dropped.
 574  *
 575  * @cliexpar
 576  * Example of how to add a dynamic MAC Address entry to the L2 FIB table
 577  * of a bridge-domain (where 200 is the bridge-domain-id):
 578  * @cliexcmd{l2fib add 52:54:00:53:18:33 200 GigabitEthernet0/8/0.200}
 579  * Example of how to add a static MAC Address entry to the L2 FIB table
 580  * of a bridge-domain (where 200 is the bridge-domain-id):
 581  * @cliexcmd{l2fib add 52:54:00:53:18:55 200 GigabitEthernet0/8/0.200 static}
 582  * Example of how to add a filter such that a packet with the given MAC
 583  * Address will be dropped in a given bridge-domain (where 200 is the
 584  * bridge-domain-id):
 585  * @cliexcmd{l2fib add 52:54:00:53:18:77 200 filter}
 586  * Example of show command of the provisioned MAC Addresses and filters:
 587  * @cliexstart{show l2fib verbose}
 588  *     Mac Address     BD Idx           Interface           Index  static  filter  bvi  refresh  timestamp
 589  *  52:54:00:53:18:33    1      GigabitEthernet0/8/0.200      3       0       0     0      0         0
 590  *  52:54:00:53:18:55    1      GigabitEthernet0/8/0.200      3       1       0     0      0         0
 591  *  52:54:00:53:18:77    1                 N/A                -1      1       1     0      0         0
 592  * 3 l2fib entries
 593  * @cliexend
 594 ?*/
 595 /* *INDENT-OFF* */
 596 VLIB_CLI_COMMAND (l2fib_add_cli, static) = {
 597   .path = "l2fib add",
 598   .short_help = "l2fib add <mac> <bridge-domain-id> filter | <intf> [static | bvi]",
 599   .function = l2fib_add,
 600 };
 601 /* *INDENT-ON* */
 602
 603
 604 static clib_error_t *
 605 l2fib_test_command_fn (vlib_main_t * vm,
 606                        unformat_input_t * input, vlib_cli_command_t * cmd)
 607 {
 608   u8 mac[8], save_mac[6];
 609   u32 bd_index = 0;
 610   u32 sw_if_index = 8;
 611   u32 is_add = 0;
 612   u32 is_del = 0;
 613   u32 is_check = 0;
 614   u32 count = 1;
 615   int mac_set = 0;
 616   int i;
 617
 618   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 619     {
 620       if (unformat (input, "mac %U", unformat_ethernet_address, mac))
 621         mac_set = 1;
 622       else if (unformat (input, "add"))
 623         is_add = 1;
 624       else if (unformat (input, "del"))
 625         is_del = 1;
 626       else if (unformat (input, "check"))
 627         is_check = 1;
 628       else if (unformat (input, "count %d", &count))
 629         ;
 630       else
 631         break;
 632     }
 633
 634   if (mac_set == 0)
 635     return clib_error_return (0, "mac not set");
 636
 637   if (is_add == 0 && is_del == 0 && is_check == 0)
 638     return clib_error_return (0,
 639                               "noop: pick at least one of (add,del,check)");
 640
 641   clib_memcpy_fast (save_mac, mac, 6);
 642
 643   if (is_add)
 644     {
 645       for (i = 0; i < count; i++)
 646         {
 647           l2fib_add_entry (mac, bd_index, sw_if_index,
 648                            L2FIB_ENTRY_RESULT_FLAG_NONE);
 649           incr_mac_address (mac);
 650         }
 651     }
 652
 653   if (is_check)
 654     {
 655       BVT (clib_bihash_kv) kv;
 656       l2fib_main_t *mp = &l2fib_main;
 657
 658       if (mp->mac_table_initialized == 0)
 659         return clib_error_return (0, "mac table is not initialized");
 660
 661       clib_memcpy_fast (mac, save_mac, 6);
 662
 663       for (i = 0; i < count; i++)
 664         {
 665           kv.key = l2fib_make_key (mac, bd_index);
 666           if (BV (clib_bihash_search) (&mp->mac_table, &kv, &kv))
 667             {
 668               clib_warning ("key %U AWOL", format_ethernet_address, mac);
 669               break;
 670             }
 671           incr_mac_address (mac);
 672         }
 673     }
 674
 675   if (is_del)
 676     {
 677       clib_memcpy_fast (mac, save_mac, 6);
 678
 679       for (i = 0; i < count; i++)
 680         {
 681           l2fib_del_entry (mac, bd_index, 0);
 682           incr_mac_address (mac);
 683         }
 684     }
 685
 686   return 0;
 687 }
 688
 689 /*?
 690  * The set of '<em>test l2fib</em>' commands allow the L2 FIB table of the default
 691  * bridge domain (bridge-domain-id of 0) to be modified.
 692  *
 693  * @cliexpar
 694  * @parblock
 695  * Example of how to add a set of 4 sequential MAC Address entries to L2
 696  * FIB table of the default bridge-domain:
 697  * @cliexcmd{test l2fib add mac 52:54:00:53:00:00 count 4}
 698  *
 699  * Show the set of 4 sequential MAC Address entries that were added:
 700  * @cliexstart{show l2fib verbose}
 701  *     Mac Address     BD Idx           Interface           Index  static  filter  bvi  refresh  timestamp
 702  * 52:54:00:53:00:00    0       GigabitEthernet0/8/0.300     8       0       0     0      0         0
 703  * 52:54:00:53:00:01    0       GigabitEthernet0/8/0.300     8       0       0     0      0         0
 704  * 52:54:00:53:00:03    0       GigabitEthernet0/8/0.300     8       0       0     0      0         0
 705  * 52:54:00:53:00:02    0       GigabitEthernet0/8/0.300     8       0       0     0      0         0
 706  * 4 l2fib entries
 707  * @cliexend
 708  *
 709  * Example of how to check that the set of 4 sequential MAC Address
 710  * entries were added to L2 FIB table of the default
 711  * bridge-domain. Used a count of 5 to produce an error:
 712  *
 713  * @cliexcmd{test l2fib check mac 52:54:00:53:00:00 count 5}
 714  * The output of the check command is in the log files. Log file
 715  * location may vary based on your OS and Version:
 716  *
 717  * <b><em># tail -f /var/log/messages | grep l2fib_test_command_fn</em></b>
 718  *
 719  * Sep  7 17:15:24 localhost vnet[4952]: l2fib_test_command_fn:446: key 52:54:00:53:00:04 AWOL
 720  *
 721  * Example of how to delete a set of 4 sequential MAC Address entries
 722  * from L2 FIB table of the default bridge-domain:
 723  * @cliexcmd{test l2fib del mac 52:54:00:53:00:00 count 4}
 724  * @endparblock
 725 ?*/
 726 /* *INDENT-OFF* */
 727 VLIB_CLI_COMMAND (l2fib_test_command, static) = {
 728   .path = "test l2fib",
 729   .short_help = "test l2fib [add|del|check] mac <base-addr> count <nn>",
 730   .function = l2fib_test_command_fn,
 731 };
 732 /* *INDENT-ON* */
 733
 734
 735 /**
 736  * Delete an entry from the l2fib.
 737  * Return 0 if the entry was deleted, or 1 it was not found or if
 738  * sw_if_index is non-zero and does not match that in the entry.
 739  */
 740 u32
 741 l2fib_del_entry (const u8 * mac, u32 bd_index, u32 sw_if_index)
 742 {
 743   l2fib_entry_result_t result;
 744   l2fib_main_t *mp = &l2fib_main;
 745   BVT (clib_bihash_kv) kv;
 746
 747   if (mp->mac_table_initialized == 0)
 748     return 1;
 749
 750   /* set up key */
 751   kv.key = l2fib_make_key (mac, bd_index);
 752
 753   if (BV (clib_bihash_search) (&mp->mac_table, &kv, &kv))
 754     return 1;
 755
 756   result.raw = kv.value;
 757
 758   /*  check if sw_if_index of entry match */
 759   if ((sw_if_index != 0) && (sw_if_index != result.fields.sw_if_index))
 760     return 1;
 761
 762   /* decrement counter if dynamically learned mac */
 763   if (!l2fib_entry_result_is_set_AGE_NOT (&result))
 764     {
 765       l2_bridge_domain_t *bd_config =
 766         vec_elt_at_index (l2input_main.bd_configs, bd_index);
 767       if (l2learn_main.global_learn_count)
 768         l2learn_main.global_learn_count--;
 769       if (bd_config->learn_count)
 770         bd_config->learn_count--;
 771     }
 772
 773   /* Remove entry from hash table */
 774   BV (clib_bihash_add_del) (&mp->mac_table, &kv, 0 /* is_add */ );
 775   return 0;
 776 }
 777
 778 /**
 779  * Delete an entry from the L2FIB.
 780  * The CLI format is:
 781  *    l2fib del <mac> <bd-id>
 782  */
 783 static clib_error_t *
 784 l2fib_del (vlib_main_t * vm,
 785            unformat_input_t * input, vlib_cli_command_t * cmd)
 786 {
 787   bd_main_t *bdm = &bd_main;
 788   clib_error_t *error = 0;
 789   u8 mac[6];
 790   u32 bd_id;
 791   u32 bd_index;
 792   uword *p;
 793
 794   if (!unformat (input, "%U", unformat_ethernet_address, mac))
 795     {
 796       error = clib_error_return (0, "expected mac address `%U'",
 797                                  format_unformat_error, input);
 798       goto done;
 799     }
 800
 801   if (!unformat (input, "%d", &bd_id))
 802     {
 803       error = clib_error_return (0, "expected bridge domain ID `%U'",
 804                                  format_unformat_error, input);
 805       goto done;
 806     }
 807
 808   p = hash_get (bdm->bd_index_by_bd_id, bd_id);
 809   if (!p)
 810     {
 811       error = clib_error_return (0, "bridge domain ID %d invalid", bd_id);
 812       goto done;
 813     }
 814   bd_index = p[0];
 815
 816   /* Delete the entry */
 817   if (l2fib_del_entry (mac, bd_index, 0))
 818     {
 819       error = clib_error_return (0, "mac entry not found");
 820       goto done;
 821     }
 822
 823 done:
 824   return error;
 825 }
 826
 827 /*?
 828  * This command deletes an existing MAC Address entry from the L2 FIB
 829  * table of an existing bridge-domain.
 830  *
 831  * @cliexpar
 832  * Example of how to delete a MAC Address entry from the L2 FIB table of a bridge-domain (where 200 is the bridge-domain-id):
 833  * @cliexcmd{l2fib del 52:54:00:53:18:33 200}
 834 ?*/
 835 /* *INDENT-OFF* */
 836 VLIB_CLI_COMMAND (l2fib_del_cli, static) = {
 837   .path = "l2fib del",
 838   .short_help = "l2fib del <mac> <bridge-domain-id> []",
 839   .function = l2fib_del,
 840 };
 841 /* *INDENT-ON* */
 842
 843 static clib_error_t *
 844 l2fib_set_scan_delay (vlib_main_t *vm, unformat_input_t *input,
 845                       vlib_cli_command_t *cmd)
 846 {
 847   clib_error_t *error = 0;
 848   u32 scan_delay;
 849   l2fib_main_t *fm = &l2fib_main;
 850
 851   if (!unformat (input, "%d", &scan_delay))
 852     {
 853       error = clib_error_return (0, "expecting delay but got `%U'",
 854                                  format_unformat_error, input);
 855       goto done;
 856     }
 857   fm->event_scan_delay = (f64) (scan_delay) *10e-3;
 858   l2fib_flush_all_mac (vlib_get_main ());
 859 done:
 860   return error;
 861 }
 862
 863 /*?
 864  * This command set scan delay (in 1/10s unit)
 865  *
 866 ?*/
 867 VLIB_CLI_COMMAND (l2fib_set_scan_delay_cli, static) = {
 868   .path = "set l2fib scan-delay",
 869   .short_help = "set l2fib scan-delay <delay>",
 870   .function = l2fib_set_scan_delay,
 871 };
 872
 873 /**
 874     Kick off ager to scan MACs to age/delete MAC entries
 875 */
 876 void
 877 l2fib_start_ager_scan (vlib_main_t * vm)
 878 {
 879   uword evt = L2_MAC_AGE_PROCESS_EVENT_ONE_PASS;
 880
 881   /* check if there is at least one bd with mac aging enabled */
 882   l2_bridge_domain_t *bd_config;
 883   vec_foreach (bd_config, l2input_main.bd_configs)
 884   {
 885     if (bd_config->bd_id != ~0 && bd_config->mac_age != 0)
 886       {
 887         evt = L2_MAC_AGE_PROCESS_EVENT_START;
 888         break;
 889       }
 890   }
 891
 892   vlib_process_signal_event (vm, l2fib_mac_age_scanner_process_node.index,
 893                              evt, 0);
 894 }
 895
 896 /**
 897     Flush all non static MACs from an interface
 898 */
 899 void
 900 l2fib_flush_int_mac (vlib_main_t * vm, u32 sw_if_index)
 901 {
 902   l2_input_seq_num_inc (sw_if_index);
 903   l2fib_start_ager_scan (vm);
 904 }
 905
 906 /**
 907     Flush all non static MACs in a bridge domain
 908 */
 909 void
 910 l2fib_flush_bd_mac (vlib_main_t * vm, u32 bd_index)
 911 {
 912   l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);
 913   bd_config->seq_num += 1;
 914   l2fib_start_ager_scan (vm);
 915 }
 916
 917 /**
 918     Flush all non static MACs - flushes all valid BDs
 919 */
 920 void
 921 l2fib_flush_all_mac (vlib_main_t * vm)
 922 {
 923   l2_bridge_domain_t *bd_config;
 924   vec_foreach (bd_config, l2input_main.bd_configs)
 925     if (bd_is_valid (bd_config))
 926     bd_config->seq_num += 1;
 927
 928   l2fib_start_ager_scan (vm);
 929 }
 930
 931
 932 /**
 933     Flush MACs, except static ones, associated with an interface
 934     The CLI format is:
 935     l2fib flush-mac interface <if-name>
 936 */
 937 static clib_error_t *
 938 l2fib_flush_mac_int (vlib_main_t * vm,
 939                      unformat_input_t * input, vlib_cli_command_t * cmd)
 940 {
 941   vnet_main_t *vnm = vnet_get_main ();
 942   clib_error_t *error = 0;
 943   u32 sw_if_index;
 944
 945   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 946     {
 947       error = clib_error_return (0, "unknown interface `%U'",
 948                                  format_unformat_error, input);
 949       goto done;
 950     }
 951
 952   l2fib_flush_int_mac (vm, sw_if_index);
 953
 954 done:
 955   return error;
 956 }
 957
 958 /**
 959     Flush all MACs, except static ones
 960     The CLI format is:
 961     l2fib flush-mac all
 962 */
 963 static clib_error_t *
 964 l2fib_flush_mac_all (vlib_main_t * vm,
 965                      unformat_input_t * input, vlib_cli_command_t * cmd)
 966 {
 967   l2fib_flush_all_mac (vm);
 968   return 0;
 969 }
 970
 971 /*?
 972  * This command kick off ager to delete all existing MAC Address entries,
 973  * except static ones, associated with an interface from the L2 FIB table.
 974  *
 975  * @cliexpar
 976  * Example of how to flush MAC Address entries learned on an interface from the L2 FIB table:
 977  * @cliexcmd{l2fib flush-mac interface GigabitEthernet2/1/0}
 978 ?*/
 979 /* *INDENT-OFF* */
 980 VLIB_CLI_COMMAND (l2fib_flush_mac_all_cli, static) = {
 981   .path = "l2fib flush-mac all",
 982   .short_help = "l2fib flush-mac all",
 983   .function = l2fib_flush_mac_all,
 984 };
 985 /* *INDENT-ON* */
 986
 987 /*?
 988  * This command kick off ager to delete all existing MAC Address entries,
 989  * except static ones, associated with an interface from the L2 FIB table.
 990  *
 991  * @cliexpar
 992  * Example of how to flush MAC Address entries learned on an interface from the L2 FIB table:
 993  * @cliexcmd{l2fib flush-mac interface GigabitEthernet2/1/0}
 994 ?*/
 995 /* *INDENT-OFF* */
 996 VLIB_CLI_COMMAND (l2fib_flush_mac_int_cli, static) = {
 997   .path = "l2fib flush-mac interface",
 998   .short_help = "l2fib flush-mac interface <if-name>",
 999   .function = l2fib_flush_mac_int,
1000 };
1001 /* *INDENT-ON* */
1002
1003 /**
1004     Flush bridge-domain MACs except static ones.
1005     The CLI format is:
1006     l2fib flush-mac bridge-domain <bd-id>
1007 */
1008 static clib_error_t *
1009 l2fib_flush_mac_bd (vlib_main_t * vm,
1010                     unformat_input_t * input, vlib_cli_command_t * cmd)
1011 {
1012   bd_main_t *bdm = &bd_main;
1013   clib_error_t *error = 0;
1014   u32 bd_index, bd_id;
1015   uword *p;
1016
1017   if (!unformat (input, "%d", &bd_id))
1018     {
1019       error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
1020                                  format_unformat_error, input);
1021       goto done;
1022     }
1023
1024   p = hash_get (bdm->bd_index_by_bd_id, bd_id);
1025   if (p)
1026     bd_index = *p;
1027   else
1028     return clib_error_return (0, "No such bridge domain %d", bd_id);
1029
1030   l2fib_flush_bd_mac (vm, bd_index);
1031
1032 done:
1033   return error;
1034 }
1035
1036 /*?
1037  * This command kick off ager to delete all existing MAC Address entries,
1038  * except static ones, in a bridge domain from the L2 FIB table.
1039  *
1040  * @cliexpar
1041  * Example of how to flush MAC Address entries learned in a bridge domain from the L2 FIB table:
1042  * @cliexcmd{l2fib flush-mac bridge-domain 1000}
1043 ?*/
1044 /* *INDENT-OFF* */
1045 VLIB_CLI_COMMAND (l2fib_flush_mac_bd_cli, static) = {
1046   .path = "l2fib flush-mac bridge-domain",
1047   .short_help = "l2fib flush-mac bridge-domain <bd-id>",
1048   .function = l2fib_flush_mac_bd,
1049 };
1050 /* *INDENT-ON* */
1051
1052 clib_error_t *
1053 l2fib_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
1054 {
1055   l2_input_config_t *config = l2input_intf_config (sw_if_index);
1056   if ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) == 0 &&
1057       l2_input_is_bridge (config))
1058     l2fib_flush_int_mac (vnm->vlib_main, sw_if_index);
1059   return 0;
1060 }
1061
1062 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (l2fib_sw_interface_up_down);
1063
1064 BVT (clib_bihash) * get_mac_table (void)
1065 {
1066   l2fib_main_t *mp = &l2fib_main;
1067   return &mp->mac_table;
1068 }
1069
1070 static_always_inline void *
1071 allocate_mac_evt_buf (u32 client, u32 client_index)
1072 {
1073   l2fib_main_t *fm = &l2fib_main;
1074   vl_api_l2_macs_event_t *mp = vl_msg_api_alloc
1075     (sizeof (*mp) + (fm->max_macs_in_event * sizeof (vl_api_mac_entry_t)));
1076   mp->_vl_msg_id = htons (l2input_main.msg_id_base + VL_API_L2_MACS_EVENT);
1077   mp->pid = htonl (client);
1078   mp->client_index = client_index;
1079   return mp;
1080 }
1081
1082 static_always_inline f64
1083 l2fib_scan (vlib_main_t * vm, f64 start_time, u8 event_only)
1084 {
1085   l2fib_main_t *fm = &l2fib_main;
1086   l2learn_main_t *lm = &l2learn_main;
1087
1088   BVT (clib_bihash) * h = &fm->mac_table;
1089   int i, j, k;
1090   f64 last_start = start_time;
1091   f64 accum_t = 0;
1092   f64 delta_t = 0;
1093   u32 evt_idx = 0;
1094   u32 learn_count = 0;
1095   u32 client = lm->client_pid;
1096   u32 cl_idx = lm->client_index;
1097   vl_api_l2_macs_event_t *mp = 0;
1098   vl_api_registration_t *reg = 0;
1099   u32 bd_index;
1100   static u32 *bd_learn_counts = 0;
1101
1102   /* Don't scan the l2 fib if it hasn't been instantiated yet */
1103   if (alloc_arena (h) == 0)
1104     return 0.0;
1105
1106   vec_reset_length (bd_learn_counts);
1107   vec_validate (bd_learn_counts, vec_len (l2input_main.bd_configs) - 1);
1108
1109   if (client)
1110     {
1111       mp = allocate_mac_evt_buf (client, cl_idx);
1112       reg = vl_api_client_index_to_registration (lm->client_index);
1113     }
1114
1115   for (i = 0; i < h->nbuckets; i++)
1116     {
1117       /* allow no more than 20us without a pause */
1118       delta_t = vlib_time_now (vm) - last_start;
1119       if (delta_t > 20e-6)
1120         {
1121           vlib_process_suspend (vm, 100e-6);    /* suspend for 100 us */
1122           /* in case a new bd was created while sleeping */
1123           vec_validate (bd_learn_counts,
1124                         vec_len (l2input_main.bd_configs) - 1);
1125           last_start = vlib_time_now (vm);
1126           accum_t += delta_t;
1127         }
1128
1129       if (i < (h->nbuckets - 3))
1130         {
1131           BVT (clib_bihash_bucket) * b =
1132             BV (clib_bihash_get_bucket) (h, i + 3);
1133           clib_prefetch_load (b);
1134           b = BV (clib_bihash_get_bucket) (h, i + 1);
1135           if (!BV (clib_bihash_bucket_is_empty) (b))
1136             {
1137               BVT (clib_bihash_value) * v =
1138                 BV (clib_bihash_get_value) (h, b->offset);
1139               clib_prefetch_load (v);
1140             }
1141         }
1142
1143       BVT (clib_bihash_bucket) * b = BV (clib_bihash_get_bucket) (h, i);
1144       if (BV (clib_bihash_bucket_is_empty) (b))
1145         continue;
1146       BVT (clib_bihash_value) * v = BV (clib_bihash_get_value) (h, b->offset);
1147       for (j = 0; j < (1 << b->log2_pages); j++)
1148         {
1149           for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1150             {
1151               if (BV (clib_bihash_is_free) (&v->kvp[k]))
1152                 continue;
1153
1154               l2fib_entry_key_t key = {.raw = v->kvp[k].key };
1155               l2fib_entry_result_t result = {.raw = v->kvp[k].value };
1156
1157               if (!l2fib_entry_result_is_set_AGE_NOT (&result))
1158                 {
1159                   learn_count++;
1160                   vec_elt (bd_learn_counts, key.fields.bd_index)++;
1161                 }
1162
1163               if (client)
1164                 {
1165                   if (PREDICT_FALSE (evt_idx >= fm->max_macs_in_event))
1166                     {
1167                       /* event message full, send it and start a new one */
1168                       if (reg && vl_api_can_send_msg (reg))
1169                         {
1170                           mp->n_macs = htonl (evt_idx);
1171                           vl_api_send_msg (reg, (u8 *) mp);
1172                           mp = allocate_mac_evt_buf (client, cl_idx);
1173                         }
1174                       else
1175                         {
1176                           if (reg)
1177                             clib_warning ("MAC event to pid %d queue stuffed!"
1178                                           " %d MAC entries lost", client,
1179                                           evt_idx);
1180                         }
1181                       evt_idx = 0;
1182                     }
1183
1184                   if (l2fib_entry_result_is_set_LRN_EVT (&result))
1185                     {
1186                       /* copy mac entry to event msg */
1187                       clib_memcpy_fast (mp->mac[evt_idx].mac_addr,
1188                                         key.fields.mac, 6);
1189                       mp->mac[evt_idx].action =
1190                         l2fib_entry_result_is_set_LRN_MOV (&result) ?
1191                         (vl_api_mac_event_action_t) MAC_EVENT_ACTION_MOVE
1192                         : (vl_api_mac_event_action_t) MAC_EVENT_ACTION_ADD;
1193                       mp->mac[evt_idx].action =
1194                         htonl (mp->mac[evt_idx].action);
1195                       mp->mac[evt_idx].sw_if_index =
1196                         htonl (result.fields.sw_if_index);
1197                       /* clear event bits and update mac entry */
1198                       l2fib_entry_result_clear_LRN_EVT (&result);
1199                       l2fib_entry_result_clear_LRN_MOV (&result);
1200                       BVT (clib_bihash_kv) kv;
1201                       kv.key = key.raw;
1202                       kv.value = result.raw;
1203                       BV (clib_bihash_add_del) (&fm->mac_table, &kv, 1);
1204                       evt_idx++;
1205                       continue; /* skip aging */
1206                     }
1207                 }
1208
1209               if (event_only || l2fib_entry_result_is_set_AGE_NOT (&result))
1210                 continue;       /* skip aging - static_mac always age_not */
1211
1212               /* start aging processing */
1213               u32 bd_index = key.fields.bd_index;
1214               u32 sw_if_index = result.fields.sw_if_index;
1215               u16 sn = l2fib_cur_seq_num (bd_index, sw_if_index);
1216               if (result.fields.sn != sn)
1217                 goto age_out;   /* stale mac */
1218
1219               l2_bridge_domain_t *bd_config =
1220                 vec_elt_at_index (l2input_main.bd_configs, bd_index);
1221
1222               if (bd_config->mac_age == 0)
1223                 continue;       /* skip aging */
1224
1225               i16 delta = (u8) (start_time / 60) - result.fields.timestamp;
1226               delta += delta < 0 ? 256 : 0;
1227
1228               if (delta < bd_config->mac_age)
1229                 continue;       /* still valid */
1230
1231             age_out:
1232               if (client)
1233                 {
1234                   /* copy mac entry to event msg */
1235                   clib_memcpy_fast (mp->mac[evt_idx].mac_addr, key.fields.mac,
1236                                     6);
1237                   mp->mac[evt_idx].action =
1238                     (vl_api_mac_event_action_t) MAC_EVENT_ACTION_DELETE;
1239                   mp->mac[evt_idx].action = htonl (mp->mac[evt_idx].action);
1240                   mp->mac[evt_idx].sw_if_index =
1241                     htonl (result.fields.sw_if_index);
1242                   evt_idx++;
1243                 }
1244               /* delete mac entry */
1245               BVT (clib_bihash_kv) kv;
1246               kv.key = key.raw;
1247               BV (clib_bihash_add_del) (&fm->mac_table, &kv, 0);
1248               learn_count--;
1249               vec_elt (bd_learn_counts, key.fields.bd_index)--;
1250               /*
1251                * Note: we may have just freed the bucket's backing
1252                * storage, so check right here...
1253                */
1254               if (BV (clib_bihash_bucket_is_empty) (b))
1255                 goto doublebreak;
1256             }
1257           v++;
1258         }
1259     doublebreak:
1260       ;
1261     }
1262
1263   /* keep learn count consistent */
1264   l2learn_main.global_learn_count = learn_count;
1265   vec_foreach_index (bd_index, l2input_main.bd_configs)
1266     {
1267       vec_elt (l2input_main.bd_configs, bd_index).learn_count =
1268         vec_elt (bd_learn_counts, bd_index);
1269     }
1270
1271   if (mp)
1272     {
1273       /*  send any outstanding mac event message else free message buffer */
1274       if (evt_idx)
1275         {
1276           if (reg && vl_api_can_send_msg (reg))
1277             {
1278               mp->n_macs = htonl (evt_idx);
1279               vl_api_send_msg (reg, (u8 *) mp);
1280             }
1281           else
1282             {
1283               if (reg)
1284                 clib_warning ("MAC event to pid %d queue stuffed!"
1285                               " %d MAC entries lost", client, evt_idx);
1286               vl_msg_api_free (mp);
1287             }
1288         }
1289       else
1290         vl_msg_api_free (mp);
1291     }
1292   return delta_t + accum_t;
1293 }
1294
1295 static uword
1296 l2fib_mac_age_scanner_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1297                                vlib_frame_t * f)
1298 {
1299   uword event_type, *event_data = 0;
1300   l2fib_main_t *fm = &l2fib_main;
1301   l2learn_main_t *lm = &l2learn_main;
1302   bool enabled = 0;
1303   f64 start_time, next_age_scan_time = CLIB_TIME_MAX;
1304
1305   while (1)
1306     {
1307       if (lm->client_pid)
1308         vlib_process_wait_for_event_or_clock (vm, fm->event_scan_delay);
1309       else if (enabled)
1310         {
1311           f64 t = next_age_scan_time - vlib_time_now (vm);
1312           vlib_process_wait_for_event_or_clock (vm, t);
1313         }
1314       else
1315         vlib_process_wait_for_event (vm);
1316
1317       event_type = vlib_process_get_events (vm, &event_data);
1318       vec_reset_length (event_data);
1319
1320       start_time = vlib_time_now (vm);
1321       enum
1322       { SCAN_MAC_AGE, SCAN_MAC_EVENT, SCAN_DISABLE } scan = SCAN_MAC_AGE;
1323
1324       switch (event_type)
1325         {
1326         case ~0:                /* timer expired */
1327           if (lm->client_pid != 0 && start_time < next_age_scan_time)
1328             scan = SCAN_MAC_EVENT;
1329           break;
1330
1331         case L2_MAC_AGE_PROCESS_EVENT_START:
1332           enabled = 1;
1333           break;
1334
1335         case L2_MAC_AGE_PROCESS_EVENT_STOP:
1336           enabled = 0;
1337           scan = SCAN_DISABLE;
1338           break;
1339
1340         case L2_MAC_AGE_PROCESS_EVENT_ONE_PASS:
1341           break;
1342
1343         default:
1344           ASSERT (0);
1345         }
1346
1347       if (scan == SCAN_MAC_EVENT)
1348         l2fib_main.evt_scan_duration = l2fib_scan (vm, start_time, 1);
1349       else
1350         {
1351           if (scan == SCAN_MAC_AGE)
1352             l2fib_main.age_scan_duration = l2fib_scan (vm, start_time, 0);
1353           if (scan == SCAN_DISABLE)
1354             {
1355               l2fib_main.age_scan_duration = 0;
1356               l2fib_main.evt_scan_duration = 0;
1357             }
1358           /* schedule next scan */
1359           if (enabled)
1360             next_age_scan_time = start_time + L2FIB_AGE_SCAN_INTERVAL;
1361           else
1362             next_age_scan_time = CLIB_TIME_MAX;
1363         }
1364     }
1365   return 0;
1366 }
1367
1368 /* *INDENT-OFF* */
1369 VLIB_REGISTER_NODE (l2fib_mac_age_scanner_process_node) = {
1370     .function = l2fib_mac_age_scanner_process,
1371     .type = VLIB_NODE_TYPE_PROCESS,
1372     .name = "l2fib-mac-age-scanner-process",
1373 };
1374 /* *INDENT-ON* */
1375
1376 clib_error_t *
1377 l2fib_init (vlib_main_t * vm)
1378 {
1379   l2fib_main_t *mp = &l2fib_main;
1380   l2fib_entry_key_t test_key;
1381   u8 test_mac[6];
1382
1383   mp->vlib_main = vm;
1384   mp->vnet_main = vnet_get_main ();
1385   if (mp->mac_table_n_buckets == 0)
1386     mp->mac_table_n_buckets = L2FIB_NUM_BUCKETS;
1387   if (mp->mac_table_memory_size == 0)
1388     mp->mac_table_memory_size = L2FIB_MEMORY_SIZE;
1389   mp->mac_table_initialized = 0;
1390
1391   /* verify the key constructor is good, since it is endian-sensitive */
1392   clib_memset (test_mac, 0, sizeof (test_mac));
1393   test_mac[0] = 0x11;
1394   test_key.raw = 0;
1395   test_key.raw = l2fib_make_key ((u8 *) & test_mac, 0x1234);
1396   ASSERT (test_key.fields.mac[0] == 0x11);
1397   ASSERT (test_key.fields.bd_index == 0x1234);
1398
1399   return 0;
1400 }
1401
1402 VLIB_INIT_FUNCTION (l2fib_init);
1403
1404 static clib_error_t *
1405 lfib_config (vlib_main_t * vm, unformat_input_t * input)
1406 {
1407   l2fib_main_t *lm = &l2fib_main;
1408   uword table_size = ~0;
1409   u32 n_buckets = ~0;
1410
1411   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1412     {
1413       if (unformat (input, "table-size %U", unformat_memory_size,
1414                     &table_size))
1415         ;
1416       else if (unformat (input, "num-buckets %u", &n_buckets))
1417         ;
1418       else
1419         return clib_error_return (0, "unknown input `%U'",
1420                                   format_unformat_error, input);
1421     }
1422
1423   if (n_buckets != ~0)
1424     {
1425       if (!is_pow2 (n_buckets))
1426         return clib_error_return (0, "num-buckets must be power of 2");
1427       lm->mac_table_n_buckets = n_buckets;
1428     }
1429
1430   if (table_size != ~0)
1431     lm->mac_table_memory_size = table_size;
1432   return 0;
1433 }
1434
1435 VLIB_CONFIG_FUNCTION (lfib_config, "l2fib");
1436
1437 /*
1438  * fd.io coding-style-patch-verification: ON
1439  *
1440  * Local Variables:
1441  * eval: (c-set-style "gnu")
1442  * End:
1443  */