vppinfra/vppinfra/mhash.h

   1 /*
   2  * Copyright (c) 2015 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 #ifndef included_clib_mhash_h
  16 #define included_clib_mhash_h
  17
  18 /*
  19   Copyright (c) 2010 Eliot Dresselhaus
  20
  21   Permission is hereby granted, free of charge, to any person obtaining
  22   a copy of this software and associated documentation files (the
  23   "Software"), to deal in the Software without restriction, including
  24   without limitation the rights to use, copy, modify, merge, publish,
  25   distribute, sublicense, and/or sell copies of the Software, and to
  26   permit persons to whom the Software is furnished to do so, subject to
  27   the following conditions:
  28
  29   The above copyright notice and this permission notice shall be
  30   included in all copies or substantial portions of the Software.
  31
  32   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  33   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  34   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  35   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  36   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  37   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  38   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  39 */
  40
  41 #include <vppinfra/format.h>
  42 #include <vppinfra/hash.h>
  43 #include <vppinfra/heap.h>
  44
  45 /* Hash table plus vector of keys. */
  46 typedef struct {
  47   /* Vector or heap used to store keys.  Hash table stores keys as byte
  48      offsets into this vector. */
  49   u8 * key_vector_or_heap;
  50
  51   /* Byte offsets of free keys in vector (used to store free keys when
  52      n_key_bytes > 1). */
  53   u32 * key_vector_free_indices;
  54
  55   u8 ** key_tmps;
  56
  57   /* Possibly fixed size of key.
  58      0 means keys are vectors of u8's.
  59      1 means keys are null terminated c strings. */
  60 #define MHASH_VEC_STRING_KEY 0
  61 #define MHASH_C_STRING_KEY 1
  62   u32 n_key_bytes;
  63
  64   /* Seed value for Jenkins hash. */
  65   u32 hash_seed;
  66
  67   /* Hash table mapping key -> value. */
  68   uword * hash;
  69
  70   /* Format function for keys. */
  71   format_function_t * format_key;
  72 } mhash_t;
  73
  74 void mhash_init (mhash_t * h, uword n_value_bytes, uword n_key_bytes);
  75
  76 always_inline void
  77 mhash_init_c_string (mhash_t * h, uword n_value_bytes)
  78 { mhash_init (h, n_value_bytes, MHASH_C_STRING_KEY); }
  79
  80 always_inline void
  81 mhash_init_vec_string (mhash_t * h, uword n_value_bytes)
  82 { mhash_init (h, n_value_bytes, MHASH_VEC_STRING_KEY); }
  83
  84 always_inline void *
  85 mhash_key_to_mem (mhash_t * h, uword key)
  86 {
  87   if (key == ~0)
  88     {
  89       u8 * key_tmp;
  90
  91       int my_cpu = os_get_cpu_number();
  92       vec_validate(h->key_tmps, my_cpu);
  93       key_tmp = h->key_tmps[my_cpu];
  94       return key_tmp;
  95     }
  96   return vec_elt_at_index (h->key_vector_or_heap, key);
  97 }
  98
  99 hash_pair_t * mhash_get_pair (mhash_t * h, void * key);
 100 uword mhash_set_mem (mhash_t * h, void * key, uword * new_value, uword * old_value);
 101 uword mhash_unset (mhash_t * h, void * key, uword * old_value);
 102
 103 always_inline uword *
 104 mhash_get (mhash_t * h, void * key)
 105 {
 106   hash_pair_t * p = mhash_get_pair (h, key);
 107   return p ? &p->value[0] : 0;
 108 }
 109
 110 always_inline uword
 111 mhash_set (mhash_t * h, void * key, uword new_value, uword * old_value)
 112 { return mhash_set_mem (h, key, &new_value, old_value); }
 113
 114 always_inline uword
 115 mhash_unset_key (mhash_t * h, uword key, uword * old_value)
 116 {
 117   void * k = mhash_key_to_mem (h, key);
 118   return mhash_unset (h, k, old_value);
 119 }
 120
 121 always_inline uword
 122 mhash_value_bytes (mhash_t * m)
 123 {
 124   hash_t * h = hash_header (m->hash);
 125   return hash_value_bytes (h);
 126 }
 127
 128 always_inline uword
 129 mhash_elts (mhash_t * m)
 130 { return hash_elts (m->hash); }
 131
 132 always_inline uword
 133 mhash_key_vector_is_heap (mhash_t * h)
 134 { return h->n_key_bytes <= 1; }
 135
 136 always_inline void
 137 mhash_free (mhash_t * h)
 138 {
 139   if (mhash_key_vector_is_heap (h))
 140     heap_free (h->key_vector_or_heap);
 141   else
 142     vec_free (h->key_vector_or_heap);
 143   vec_free (h->key_vector_free_indices);
 144   hash_free (h->hash);
 145 }
 146
 147 #define mhash_foreach(k,v,mh,body)                              \
 148 do {                                                            \
 149   hash_pair_t * _mhash_foreach_p;                               \
 150   hash_foreach_pair (_mhash_foreach_p, (mh)->hash, ({           \
 151     (k) = mhash_key_to_mem ((mh), _mhash_foreach_p->key);       \
 152     (v) = &_mhash_foreach_p->value[0];                          \
 153     body;                                                       \
 154   }));                                                          \
 155 } while (0)
 156
 157 format_function_t format_mhash_key;
 158
 159 #endif /* included_clib_mhash_h */