<
/*
 * l2_fib.h : layer 2 forwarding table (aka mac table)
 *
 * Copyright (c) 2013 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef included_l2fib_h
#define included_l2fib_h

#include <vlib/vlib.h>
#include <vppinfra/bihash_8_8.h>

/*
 * The size of the hash table
 */
#define L2FIB_NUM_BUCKETS (64 * 1024)
#define L2FIB_MEMORY_SIZE (256<<20)

/* Ager scan interval is 1 minute for aging */
#define L2FIB_AGE_SCAN_INTERVAL		(60.0)

/* MAC event scan delay is 100 msec unless specified by MAC event client */
#define L2FIB_EVENT_SCAN_DELAY_DEFAULT	(0.1)

/* Max MACs in a event message is 100 unless specified by MAC event client */
#define L2FIB_EVENT_MAX_MACS_DEFAULT	(100)

/* MAC event learn limit is 1000 unless specified by MAC event client */
#define L2FIB_EVENT_LEARN_LIMIT_DEFAULT	(1000)

typedef struct
{

  /* hash table */
  BVT (clib_bihash) mac_table;

  /* per swif vector of sequence number for interface based flush of MACs */
  u8 *swif_seq_num;

  /* last event or ager scan duration */
  f64 evt_scan_duration;
  f64 age_scan_duration;

  /* delay between event scans, default to 100 msec */
  f64 event_scan_delay;

  /* max macs in evet message, default to 100 entries */
  u32 max_macs_in_event;

  /* convenience variables */
  vlib_main_t *vlib_main;
  vnet_main_t *vnet_main;
} l2fib_main_t;

extern l2fib_main_t l2fib_main;

/*
 * The L2fib key is the mac address and bridge domain ID
 */
typedef struct
{
  union
  {
    struct
    {
      u16 bd_index;
      u8 mac[6];
    } fields;
    struct
    {
      u32 w0;
      u32 w1;
    } words;
    u64 raw;
  };
} l2fib_entry_key_t;

STATIC_ASSERT_SIZEOF (l2fib_entry_key_t, 8);


typedef struct
{
  union
  {
    struct
    {
      u8 swif;
      u8 
@media only all and (prefers-color-scheme: dark) {
.highlight .hll { background-color: #49483e }
.highlight .c { color: #75715e } /* Comment */
.highlight .err { color: #960050; background-color: #1e0010 } /* Error */
.highlight .k { color: #66d9ef } /* Keyword */
.highlight .l { color: #ae81ff } /* Literal */
.highlight .n { color: #f8f8f2 } /* Name */
.highlight .o { color: #f92672 } /* Operator */
.highlight .p { color: #f8f8f2 } /* Punctuation */
.highlight .ch { color: #75715e } /* Comment.Hashbang */
.highlight .cm { color: #75715e } /* Comment.Multiline */
.highlight .cp { color: #75715e } /* Comment.Preproc */
.highlight .cpf { color: #75715e } /* Comment.PreprocFile */
.highlight .c1 { color: #75715e } /* Comment.Single */
.highlight .cs { color: #75715e } /* Comment.Special */
.highlight .gd { color: #f92672 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gi { color: #a6e22e } /* Generic.Inserted */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #75715e } /* Generic.Subheading */
.highlight .kc { color: #66d9ef } /* Keyword.Constant */
.highlight .kd { color: #66d9ef } /* Keyword.Declaration */
.highlight .kn { color: #f92672 } /* Keyword.Namespace */
.highlight .kp { color: #66d9ef } /* Keyword.Pseudo */
.highlight .kr { color: #66d9ef } /* Keyword.Reserved */
.highlight .kt { color: #66d9ef } /* Keyword.Type */
.highlight .ld { color: #e6db74 } /* Literal.Date */
.highlight .m { color: #ae81ff } /* Literal.Number */
.highlight .s { color: #e6db74 } /* Literal.String */
.highlight .na { color: #a6e22e } /* Name.Attribute */
.highlight .nb { color: #f8f8f2 } /* Name.Builtin */
.highlight .nc { color: #a6e22e } /* Name.Class */
.highlight .no { color: #66d9ef } /* Name.Constant */
.highlight .nd { color: #a6e22e } /* Name.Decorator */
.highlight .ni { color: #f8f8f2 } /* Name.Entity */
.highlight .ne { color: #a6e22e } /* Name.Exception */
.highlight .nf { color: #a6e22e } /* Name.Function */
.highlight .nl { color: #f8f8f2 } /* Name.Label */
.highlight .nn { color: #f8f8f2 } /* Name.Namespace */
.highlight .nx { color: #a6e22e } /* Name.Other */
.highlight .py { color: #f8f8f2 } /* Name.Property */
.highlight .nt { color: #f92672 } /* Name.Tag */
.highlight .nv { color: #f8f8f2 } /* Name.Variable */
.highlight .ow { color: #f92672 } /* Operator.Word */
.highlight .w { color: #f8f8f2 } /* Text.Whitespace */
.highlight .mb { color: #ae81ff } /* Literal.Number.Bin */
.highlight .mf { color: #ae81ff } /* Literal.Number.Float */
.highlight .mh { color: #ae81ff } /* Literal.Number.Hex */
.highlight .mi { color: #ae81ff } /* Literal.Number.Integer */
.highlight .mo { color: #ae81ff } /* Literal.Number.Oct */
.highlight .sa { color: #e6db74 } /* Literal.String.Affix */
.highlight .sb { color: #e6db74 } /* Literal.String.Backtick */
.highlight .sc { color: #e6db74 } /* Literal.String.Char */
.highlight .dl { color: #e6db74 } /* Literal.String.Delimiter */
.highlight .sd { color: #e6db74 } /* Literal.String.Doc */
.highlight .s2 { color: #e6db74 } /* Literal.String.Double */
.highlight .se { color: #ae81ff } /* Literal.String.Escape */
.highlight .sh { color: #e6db74 } /* Literal.String.Heredoc */
.highlight .si { color: #e6db74 } /* Literal.String.Interpol */
.highlight .sx { color: #e6db74 } /* Literal.String.Other */
.highlight .sr { color: #e6db74 } /* Literal.String.Regex */
.highlight .s1 { color: #e6db74 } /* Literal.String.Single */
.highlight .ss { color: #e6db74 } /* Literal.String.Symbol */
.highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #a6e22e } /* Name.Function.Magic */
.highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */
.highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */
.highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */
.highlight .vm { color: #f8f8f2 } /* Name.Variable.Magic */
.highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */
}
@media (prefers-color-scheme: light) {
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
}
/*
 * Copyright (c) 2015 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
  Copyright (c) 2006 Eliot Dresselhaus

  Permission is hereby granted, free of charge, to any person obtaining
  a copy of this software and associated documentation files (the
  "Software"), to deal in the Software without restriction, including
  without limitation the rights to use, copy, modify, merge, publish,
  distribute, sublicense, and/or sell copies of the Software, and to
  permit persons to whom the Software is furnished to do so, subject to
  the following conditions:

  The above copyright notice and this permission notice shall be
  included in all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#include <vppinfra/qhash.h>

#define QHASH_ALL_VALID ((1 << QHASH_KEYS_PER_BUCKET) - 1)

void *
_qhash_resize (void *v, uword length, uword elt_bytes)
{
  qhash_t *h;
  uword l;

  l = clib_max (max_log2 (length), 2 + QHASH_LOG2_KEYS_PER_BUCKET);

  /* Round up if less than 1/2 full. */
  l += ((f64) length / (f64) (1 << l)) < .5;

  v = _vec_resize (0, 1 << l, elt_bytes << l, sizeof (h[0]),
		   /* align */ sizeof (uword));

  h = qhash_header (v);
  h->n_elts = 0;
  h->log2_hash_size = l;
  h->hash_keys =
    clib_mem_alloc_aligned_no_fail (sizeof (h->hash_keys[0]) << l,
				    CLIB_CACHE_LINE_BYTES);
  vec_resize (h->hash_key_valid_bitmap,
	      1 << (l - QHASH_LOG2_KEYS_PER_BUCKET));
  clib_memset (v, ~0, elt_bytes << l);

  return v;
}

static u8 min_log2_table[256];

static inline uword
qhash_min_log2 (uword x)
{
  ASSERT (is_pow2 (x));
  ASSERT (x < 256);
  return min_log2_table[x];
}

static void
qhash_min_log2_init ()
{
  int i;
  for (i = 0; i < 256; i++)
    min_log2_table[i] = min_log2 (i);
}

always_inline uword
qhash_get_valid_elt_mask (qhash_t * h, uword i)
{
  return h->hash_key_valid_bitmap[i / QHASH_KEYS_PER_BUCKET];
}

always_inline void
qhash_set_valid_elt_mask (qhash_t * h, uword i, uword mask)
{
  h->hash_key_valid_bitmap[i / QHASH_KEYS_PER_BUCKET] = mask;
}

always_inline uword
qhash_search_bucket (uword * hash_keys, uword search_key, uword m)
{
  uword t;
#define _(i) ((hash_keys[i] == search_key) << i)
  t = (_(0) | _(1) | _(2) | _(3));
  if (QHASH_KEYS_PER_BUCKET > 4)
    t |= (_(4) | _(5) | _(6) | _(7));
  if (QHASH_KEYS_PER_BUCKET > 8)
    t |= (_(8) | _(9) | _(10) | _(11) | _(12) | _(13) | _(14) | _(15));
#undef _
  return m & t;
}

/* Lookup multiple keys in the same hash table. */
void
qhash_get_multiple (void *v,
		    uword * search_keys,
		    uword n_search_keys, u32 * result_indices)
{
  qhash_t *h = qhash_header (v);
  uword *k, *hash_keys;
  uword n_left, bucket_mask;
  u32 *r;

  if (!v)
    {
      clib_memset (result_indices, ~0,
		   sizeof (result_indices[0]) * n_search_keys);
      return;
    }

  bucket_mask = pow2_mask (h->log2_hash_size) & ~(QHASH_KEYS_PER_BUCKET - 1);

  k = search_keys;
  n_left = n_search_keys;
  hash_keys = h->hash_keys;
  r = result_indices;

  while (n_left >= 2)
    {
      u32 a0, b0, c0, bi0, valid0, match0;
      u32 a1, b1, c1, bi1, valid1, match1;
      uword k0, k1, *h0, *h1;

      k0 = k[0];
      k1 = k[1];
      n_left -= 2;
      k += 2;

      a0 = a1 = h->hash_seeds[0];
      b0 = b1 = h->hash_seeds[1];
      c0 = c1 = h->hash_seeds[2];
      a0 ^= k0;
      a1 ^= k1;
#if uword_bits == 64
      b0 ^= k0 >> 32;
      b1 ^= k1 >> 32;
#endif

      hash_mix32_step_1 (a0, b0, c0);
      hash_mix32_step_1 (a1, b1, c1);
      hash_mix32_step_2 (a0, b0, c0);
      hash_mix32_step_2 (a1, b1, c1);
      hash_mix32_step_3 (a0, b0, c0);
      hash_mix32_step_3 (a1, b1, c1);

      bi0 = c0 & bucket_mask;
      bi1 = c1 & bucket_mask;

      h0 = hash_keys + bi0;
      h1 = hash_keys + bi1;

      /* Search two buckets. */
      valid0 = qhash_get_valid_elt_mask (h, bi0);
      valid1 = qhash_get_valid_elt_mask (h, bi1);

      match0 = qhash_search_bucket (h0, k0, valid0);
      match1 = qhash_search_bucket (h1, k1, valid1);

      bi0 += qhash_min_log2 (match0);
      bi1 += qhash_min_log2 (match1);

      r[0] = match0 ? bi0 : ~0;
      r[1] = match1 ? bi1 : ~0;
      r += 2;

      /* Full buckets trigger search of overflow hash. */
      if (PREDICT_FALSE (!match0 && valid0 == QHASH_ALL_VALID))
	{
	  uword *p = hash_get (h->overflow_hash, k0);
	  r[-2] = p ? p[0] : ~0;
	}

      /* Full buckets trigger search of overflow hash. */
      if (PREDICT_FALSE (!match1 && valid1 == QHASH_ALL_VALID))
	{
	  uword *p = hash_get (h->overflow_hash, k1);
	  r[-1] = p ? p[0] : ~0;
	}
    }

  while (n_left >= 1)
    {
      u32 a0, b0, c0, bi0, valid0, match0;
      uword k0, *h0;

      k0 = k[0];
      n_left -= 1;
      k += 1;

      a0 = h->hash_seeds[0];
      b0 = h->hash_seeds[1];
      c0 = h->hash_seeds[2];
      a0 ^= k0;
#if uword_bits == 64
      b0 ^= k0 >> 32;
#endif

      hash_mix32 (a0, b0, c0);

      bi0 = c0 & bucket_mask;

      h0 = hash_keys + bi0;

      /* Search one bucket. */
      valid0 = qhash_get_valid_elt_mask (h, bi0);
      match0 = qhash_search_bucket (h0, k0, valid0);

      bi0 += qhash_min_log2 (match0);

      r[0] = match0 ? bi0 : ~0;
      r += 1;

      /* Full buckets trigger search of overflow hash. */
      if (PREDICT_FALSE (!match0 && valid0 == QHASH_ALL_VALID))
	{
	  uword *p = hash_get (h->overflow_hash, k0);
	  r[-1] = p ? p[0] : ~0;
	}
    }
}

/* Lookup multiple keys in the same hash table.
   Returns index of first matching key. */
u32
qhash_get_first_match (void *v,
		       uword * search_keys,
		       uword n_search_keys, uword * matching_key)
{
  qhash_t *h = qhash_header (v);
  uword *k, *hash_keys;
  uword n_left, match_mask, bucket_mask;

  if (!v)
    return ~0;

  match_mask = 0;
  bucket_mask = pow2_mask (h->log2_hash_size) & ~(QHASH_KEYS_PER_BUCKET - 1);

  k = search_keys;
  n_left = n_search_keys;
  hash_keys = h->hash_keys;
  while (n_left >= 2)
    {
      u32 a0, b0, c0, bi0, valid0;
      u32 a1, b1, c1, bi1, valid1;
      uword k0, k1, *h0, *h1;

      k0 = k[0];
      k1 = k[1];
      n_left -= 2;
      k += 2;

      a0 = a1 = h->hash_seeds[0];
      b0 = b1 = h->hash_seeds[1];
      c0 = c1 = h->hash_seeds[2];
      a0 ^= k0;
      a1 ^= k1;
#if uword_bits == 64
      b0 ^= k0 >> 32;
      b1 ^= k1 >> 32;
#endif

      hash_mix32_step_1 (a0, b0, c0);
      hash_mix32_step_1 (a1, b1, c1);
      hash_mix32_step_2 (a0, b0, c0);
      hash_mix32_step_2 (a1, b1, c1);
      hash_mix32_step_3 (a0, b0, c0);
      hash_mix32_step_3 (a1, b1, c1);

      bi0 = c0 & bucket_mask;
      bi1 = c1 & bucket_mask;

      h0 = hash_keys + bi0;
      h1 = hash_keys + bi1;

      /* Search two buckets. */
      valid0 = qhash_get_valid_elt_mask (h, bi0);
      valid1 = qhash_get_valid_elt_mask (h, bi1);
      match_mask = qhash_search_bucket (h0, k0, valid0);
      match_mask |= (qhash_search_bucket (h1, k1, valid1)
		     << QHASH_KEYS_PER_BUCKET);
      if (match_mask)
	{
	  uword bi, is_match1;

	  bi = qhash_min_log2 (match_mask);
	  is_match1 = bi >= QHASH_KEYS_PER_BUCKET;

	  bi += ((is_match1 ? bi1 : bi0)
		 - (is_match1 << QHASH_LOG2_KEYS_PER_BUCKET));
	  *matching_key = (k - 2 - search_keys) + is_match1;
	  return bi;
	}

      /* Full buckets trigger search of overflow hash. */
      if (PREDICT_FALSE (valid0 == QHASH_ALL_VALID
			 || valid1 == QHASH_ALL_VALID))
	{
	  uword *p = 0;
	  uword ki = k - 2 - search_keys;

	  if (valid0 == QHASH_ALL_VALID)
	    p = hash_get (h->overflow_hash, k0);

	  if (!p && valid1 == QHASH_ALL_VALID)
	    {
	      p = hash_get (h->overflow_hash, k1);
	      ki++;
	    }

	  if (p)
	    {
	      *matching_key = ki;
	      return p[0];
	    }
	}
    }

  while (n_left >= 1)
    {
      u32 a0, b0, c0, bi0, valid0;
      uword k0, *h0;

      k0 = k[0];
      n_left -= 1;
      k += 1;

      a0 = h->hash_seeds[0];
      b0 = h->hash_seeds[1];
      c0 = h->hash_seeds[2];
      a0 ^= k0;
#if uword_bits == 64
      b0 ^= k0 >> 32;
#endif

      hash_mix32 (a0, b0, c0);

      bi0 = c0 & bucket_mask;

      h0 = hash_keys + bi0;

      /* Search one bucket. */
      valid0 = qhash_get_valid_elt_mask (h, bi0);
      match_mask = qhash_search_bucket (h0, k0, valid0);
      if (match_mask)
	{
	  uword bi;
	  bi = bi0 + qhash_min_log2 (match_mask);
	  *matching_key = (k - 1 - search_keys);
	  return bi;
	}

      /* Full buckets trigger search of overflow hash. */
      if (PREDICT_FALSE (valid0 == QHASH_ALL_VALID))
	{
	  uword *p = hash_get (h->overflow_hash, k0);
	  if (p)
	    {
	      *matching_key = (k - 1 - search_keys);
	      return p[0];
	    }
	}
    }

  return ~0;
}

static void *
qhash_set_overflow (void *v, uword elt_bytes,
		    uword key, uword bi, uword * n_elts, u32 * result)
{
  qhash_t *h = qhash_header (v);
  uword *p = hash_get (h->overflow_hash, key);
  uword i;

  bi /= QHASH_KEYS_PER_BUCKET;

  if (p)
    i = p[0];
  else
    {
      uword l = vec_len (h->overflow_free_indices);
      if (l > 0)
	{
	  i = h->overflow_free_indices[l - 1];
	  _vec_len (h->overflow_free_indices) = l - 1;
	}
      else
	i = (1 << h->log2_hash_size) + hash_elts (h->overflow_hash);
      hash_set (h->overflow_hash, key, i);
      vec_validate (h->overflow_counts, bi);
      h->overflow_counts[bi] += 1;
      *n_elts += 1;

      l = vec_len (v);
      if (i >= l)
	{
	  uword dl = round_pow2 (1 + i - l, 8);
	  v = _vec_resize (v, dl, (l + dl) * elt_bytes, sizeof (h[0]),
			   /* align */ sizeof (uword));
	  clib_memset (v + l * elt_bytes, ~0, dl * elt_bytes);
	}
    }

  *result = i;

  return v;
}

static uword
qhash_unset_overflow (void *v, uword key, uword bi, uword * n_elts)
{
  qhash_t *h = qhash_header (v);
  uword *p = hash_get (h->overflow_hash, key);
  uword result;

  bi /= QHASH_KEYS_PER_BUCKET;

  if (p)
    {
      result = p[0];
      hash_unset (h->overflow_hash, key);
      ASSERT (bi < vec_len (h->overflow_counts));
      ASSERT (h->overflow_counts[bi] > 0);
      ASSERT (*n_elts > 0);
      vec_add1 (h->overflow_free_indices, result);
      h->overflow_counts[bi] -= 1;
      *n_elts -= 1;
    }
  else
    result = ~0;

  return result;
}

always_inline uword
qhash_find_free (uword i, uword valid_mask)
{
  return first_set (~valid_mask & pow2_mask (QHASH_KEYS_PER_BUCKET));
}

void *
_qhash_set_multiple (void *v,
		     uword elt_bytes,
		     uword * search_keys,
		     uword n_search_keys, u32 * result_indices)
{
  qhash_t *h = qhash_header (v);
  uword *k, *hash_keys;
  uword n_left, n_elts, bucket_mask;
  u32 *r;

  if (vec_len (v) < n_search_keys)
    v = _qhash_resize (v, n_search_keys, elt_bytes);

  if (qhash_min_log2 (2) != 1)
    {
      qhash_min_log2_init ();
      ASSERT (qhash_min_log2 (2) == 1);
    }

  ASSERT (v != 0);

  bucket_mask = pow2_mask (h->log2_hash_size) & ~(QHASH_KEYS_PER_BUCKET - 1);

  hash_keys = h->hash_keys;
  k = search_keys;
  r = result_indices;
  n_left = n_search_keys;
  n_elts = h->n_elts;

  while (n_left >= 2)
    {
      u32 a0, b0, c0, bi0, match0, valid0, free0;
      u32 a1, b1, c1, bi1, match1, valid1, free1;
      uword k0, *h0;
      uword k1, *h1;

      k0 = k[0];
      k1 = k[1];

      /* Keys must be unique. */
      ASSERT (k0 != k1);

      n_left -= 2;
      k += 2;

      a0 = a1 = h->hash_seeds[0];
      b0 = b1 = h->hash_seeds[1];
      c0 = c1 = h->hash_seeds[2];
      a0 ^= k0;
      a1 ^= k1;
#if uword_bits == 64
      b0 ^= k0 >> 32;
      b1 ^= k1 >> 32;
#endif

      hash_mix32_step_1 (a0, b0, c0);
      hash_mix32_step_1 (a1, b1, c1);
      hash_mix32_step_2 (a0, b0, c0);
      hash_mix32_step_2 (a1, b1, c1);
      hash_mix32_step_3 (a0, b0, c0);
      hash_mix32_step_3 (a1, b1, c1);

      bi0 = c0 & bucket_mask;
      bi1 = c1 & bucket_mask;

      h0 = hash_keys + bi0;
      h1 = hash_keys + bi1;

      /* Search two buckets. */
      valid0 = qhash_get_valid_elt_mask (h, bi0);
      valid1 = qhash_get_valid_elt_mask (h, bi1);

      match0 = qhash_search_bucket (h0, k0, valid0);
      match1 = qhash_search_bucket (h1, k1, valid1);

      /* Find first free element starting at hash offset into bucket. */
      free0 = qhash_find_free (c0 & (QHASH_KEYS_PER_BUCKET - 1), valid0);

      valid1 = valid1 | (bi0 == bi1 ? free0 : 0);
      free1 = qhash_find_free (c1 & (QHASH_KEYS_PER_BUCKET - 1), valid1);

      n_elts += (match0 == 0) + (match1 == 0);

      match0 = match0 ? match0 : free0;
      match1 = match1 ? match1 : free1;

      valid0 |= match0;
      valid1 |= match1;

      h0 += qhash_min_log2 (match0);
      h1 += qhash_min_log2 (match1);

      if (PREDICT_FALSE (!match0 || !match1))
	goto slow_path2;

      h0[0] = k0;
      h1[0] = k1;
      r[0] = h0 - hash_keys;
      r[1] = h1 - hash_keys;
      r += 2;
      qhash_set_valid_elt_mask (h, bi0, valid0);
      qhash_set_valid_elt_mask (h, bi1, valid1);
      continue;

    slow_path2:
      if (!match0)
	{
	  n_elts -= 1;
	  v = qhash_set_overflow (v, elt_bytes, k0, bi0, &n_elts, &r[0]);
	}
      else
	{
	  h0[0] = k0;
	  r[0] = h0 - hash_keys;
	  qhash_set_valid_elt_mask (h, bi0, valid0);
	}
      if (!match1)
	{
	  n_elts -= 1;
	  v = qhash_set_overflow (v, elt_bytes, k1, bi1, &n_elts, &r[1]);
	}
      else
	{
	  h1[0] = k1;
	  r[1] = h1 - hash_keys;
	  qhash_set_valid_elt_mask (h, bi1, valid1);
	}
      r += 2;
    }

  while (n_left >= 1)
    {
      u32 a0, b0, c0, bi0, match0, valid0, free0;
      uword k0, *h0;

      k0 = k[0];
      n_left -= 1;
      k += 1;

      a0 = h->hash_seeds[0];
      b0 = h->hash_seeds[1];
      c0 = h->hash_seeds[2];
      a0 ^= k0;
#if uword_bits == 64
      b0 ^= k0 >> 32;
#endif

      hash_mix32 (a0, b0, c0);

      bi0 = c0 & bucket_mask;

      h0 = hash_keys + bi0;

      valid0 = qhash_get_valid_elt_mask (h, bi0);

      /* Find first free element starting at hash offset into bucket. */
      free0 = qhash_find_free (c0 & (QHASH_KEYS_PER_BUCKET - 1), valid0);

      match0 = qhash_search_bucket (h0, k0, valid0);

      n_elts += (match0 == 0);

      match0 = match0 ? match0 : free0;

      valid0 |= match0;

      h0 += qhash_min_log2 (match0);

      if (PREDICT_FALSE (!match0))
	goto slow_path1;

      h0[0] = k0;
      r[0] = h0 - hash_keys;
      r += 1;
      qhash_set_valid_elt_mask (h, bi0, valid0);
      continue;

    slow_path1:
      n_elts -= 1;
      v = qhash_set_overflow (v, elt_bytes, k0, bi0, &n_elts, &r[0]);
      r += 1;
    }

  h = qhash_header (v);
  h->n_elts = n_elts;

  return v;
}

static uword
unset_slow_path (void *v, uword elt_bytes,
		 uword k0, uword bi0, uword valid0, uword match0,
		 uword * n_elts)
{
  qhash_t *h = qhash_header (v);
  uword i, j = 0, k, l, t = ~0;
  hash_pair_t *p, *found;

  if (!match0)
    {
      if (valid0 == QHASH_ALL_VALID)
	t = qhash_unset_overflow (v, k0, bi0, n_elts);
      return t;
    }

  i = bi0 / QHASH_KEYS_PER_BUCKET;
  t = bi0 + qhash_min_log2 (match0);

  if (valid0 == QHASH_ALL_VALID
      && i < vec_len (h->overflow_counts) && h->overflow_counts[i] > 0)
    {
      found = 0;
      /* *INDENT-OFF* */
      hash_foreach_pair (p, h->overflow_hash, ({
	j = qhash_hash_mix (h, p->key) / QHASH_KEYS_PER_BUCKET;
	if (j == i)
	  {
	    found = p;
	    break;
	  }
      }));
      /* *INDENT-ON* */
      ASSERT (found != 0);
      ASSERT (j == i);

      l = found->value[0];
      k = found->key;
      hash_unset3 (h->overflow_hash, k, &j);
      vec_add1 (h->overflow_free_indices, j);
      h->overflow_counts[i] -= 1;

      qhash_set_valid_elt_mask (h, bi0, valid0);

      h->hash_keys[t] = k;
      clib_memswap (v + t * elt_bytes, v + l * elt_bytes, elt_bytes);
      t = l;
    }
  else
    qhash_set_valid_elt_mask (h, bi0, valid0 ^ match0);

  return t;
}

void
_qhash_unset_multiple (void *v,
		       uword elt_bytes,
		       uword * search_keys,
		       uword n_search_keys, u32 * result_indices)
{
  qhash_t *h = qhash_header (v);
  uword *k, *hash_keys;
  uword n_left, n_elts, bucket_mask;
  u32 *r;

  if (!v)
    {
      uword i;
      for (i = 0; i < n_search_keys; i++)
	result_indices[i] = ~0;
    }

  bucket_mask = pow2_mask (h->log2_hash_size) & ~(QHASH_KEYS_PER_BUCKET - 1);

  hash_keys = h->hash_keys;
  k = search_keys;
  r = result_indices;
  n_left = n_search_keys;
  n_elts = h->n_elts;

  while (n_left >= 2)
    {
      u32 a0, b0, c0, bi0, match0, valid0;
      u32 a1, b1, c1, bi1, match1, valid1;
      uword k0, *h0;
      uword k1, *h1;

      k0 = k[0];
      k1 = k[1];

      /* Keys must be unique. */
      ASSERT (k0 != k1);

      n_left -= 2;
      k += 2;

      a0 = a1 = h->hash_seeds[0];
      b0 = b1 = h->hash_seeds[1];
      c0 = c1 = h->hash_seeds[2];
      a0 ^= k0;
      a1 ^= k1;
#if uword_bits == 64
      b0 ^= k0 >> 32;
      b1 ^= k1 >> 32;
#endif

      hash_mix32_step_1 (a0, b0, c0);
      hash_mix32_step_1 (a1, b1, c1);
      hash_mix32_step_2 (a0, b0, c0);
      hash_mix32_step_2 (a1, b1, c1);
      hash_mix32_step_3 (a0, b0, c0);
      hash_mix32_step_3 (a1, b1, c1);

      bi0 = c0 & bucket_mask;
      bi1 = c1 & bucket_mask;

      h0 = hash_keys + bi0;
      h1 = hash_keys + bi1;

      /* Search two buckets. */
      valid0 = qhash_get_valid_elt_mask (h, bi0);
      valid1 = qhash_get_valid_elt_mask (h, bi1);

      match0 = qhash_search_bucket (h0, k0, valid0);
      match1 = qhash_search_bucket (h1, k1, valid1);

      n_elts -= (match0 != 0) + (match1 != 0);

      if (PREDICT_FALSE (valid0 == QHASH_ALL_VALID
			 || valid1 == QHASH_ALL_VALID))
	goto slow_path2;

      valid0 ^= match0;
      qhash_set_valid_elt_mask (h, bi0, valid0);

      valid1 = bi0 == bi1 ? valid0 : valid1;
      valid1 ^= match1;

      qhash_set_valid_elt_mask (h, bi1, valid1);

      r[0] = match0 ? bi0 + qhash_min_log2 (match0) : ~0;
      r[1] = match1 ? bi1 + qhash_min_log2 (match1) : ~0;
      r += 2;
      continue;

    slow_path2:
      r[0] = unset_slow_path (v, elt_bytes, k0, bi0, valid0, match0, &n_elts);
      if (bi0 == bi1)
	{
	  /* Search again in same bucket to test new overflow element. */
	  valid1 = qhash_get_valid_elt_mask (h, bi0);
	  if (!match1)
	    {
	      match1 = qhash_search_bucket (h1, k1, valid1);
	      n_elts -= (match1 != 0);
	    }
	}
      r[1] = unset_slow_path (v, elt_bytes, k1, bi1, valid1, match1, &n_elts);
      r += 2;
    }

  while (n_left >= 1)
    {
      u32 a0, b0, c0, bi0, match0, valid0;
      uword k0, *h0;

      k0 = k[0];
      n_left -= 1;
      k += 1;

      a0 = h->hash_seeds[0];
      b0 = h->hash_seeds[1];
      c0 = h->hash_seeds[2];
      a0 ^= k0;
#if uword_bits == 64
      b0 ^= k0 >> 32;
#endif

      hash_mix32 (a0, b0, c0);

      bi0 = c0 & bucket_mask;

      h0 = hash_keys + bi0;

      valid0 = qhash_get_valid_elt_mask (h, bi0);

      match0 = qhash_search_bucket (h0, k0, valid0);
      n_elts -= (match0 != 0);
      qhash_set_valid_elt_mask (h, bi0, valid0 ^ match0);

      r[0] = match0 ? bi0 + qhash_min_log2 (match0) : ~0;
      r += 1;

      if (PREDICT_FALSE (valid0 == QHASH_ALL_VALID))
	r[-1] = unset_slow_path (v, elt_bytes, k0, bi0, valid0, match0,
				 &n_elts);
    }

  h->n_elts = n_elts;
}

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */