src/vppinfra/bihash_8_16.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 #undef BIHASH_TYPE
  16 #undef BIHASH_KVP_PER_PAGE
  17 #undef BIHASH_32_64_SVM
  18 #undef BIHASH_ENABLE_STATS
  19 #undef BIHASH_KVP_AT_BUCKET_LEVEL
  20 #undef BIHASH_LAZY_INSTANTIATE
  21 #undef BIHASH_BUCKET_PREFETCH_CACHE_LINES
  22 #undef BIHASH_USE_HEAP
  23
  24 #define BIHASH_TYPE _8_16
  25 #define BIHASH_KVP_PER_PAGE 7
  26 #define BIHASH_KVP_AT_BUCKET_LEVEL 1
  27 #define BIHASH_LAZY_INSTANTIATE 0
  28 #define BIHASH_BUCKET_PREFETCH_CACHE_LINES 2
  29 #define BIHASH_USE_HEAP 1
  30
  31 #ifndef __included_bihash_8_16_h__
  32 #define __included_bihash_8_16_h__
  33
  34 #include <vppinfra/heap.h>
  35 #include <vppinfra/format.h>
  36 #include <vppinfra/pool.h>
  37 #include <vppinfra/xxhash.h>
  38 #include <vppinfra/crc32.h>
  39
  40 /** 8 octet key, 8 octet key value pair */
  41 typedef struct
  42 {
  43   u64 key;                      /**< the key */
  44   u64 value[2];                 /**< the value */
  45 } clib_bihash_kv_8_16_t;
  46
  47 static inline void
  48 clib_bihash_mark_free_8_16 (clib_bihash_kv_8_16_t *v)
  49 {
  50   v->value[0] = 0xFEEDFACE8BADF00DULL;
  51 }
  52
  53 /** Decide if a clib_bihash_kv_8_16_t instance is free
  54     @param v- pointer to the (key,value) pair
  55 */
  56 static inline int
  57 clib_bihash_is_free_8_16 (clib_bihash_kv_8_16_t * v)
  58 {
  59   if (v->value[0] == 0xFEEDFACE8BADF00DULL)
  60     return 1;
  61   return 0;
  62 }
  63
  64 /** Hash a clib_bihash_kv_8_16_t instance
  65     @param v - pointer to the (key,value) pair, hash the key (only)
  66 */
  67 static inline u64
  68 clib_bihash_hash_8_16 (clib_bihash_kv_8_16_t * v)
  69 {
  70   /* Note: to torture-test linear scan, make this fn return a constant */
  71 #ifdef clib_crc32c_uses_intrinsics
  72   return clib_crc32c ((u8 *) & v->key, 8);
  73 #else
  74   return clib_xxhash (v->key);
  75 #endif
  76 }
  77
  78 /** Format a clib_bihash_kv_8_16_t instance
  79     @param s - u8 * vector under construction
  80     @param args (vararg) - the (key,value) pair to format
  81     @return s - the u8 * vector under construction
  82 */
  83 static inline u8 *
  84 format_bihash_kvp_8_16 (u8 * s, va_list * args)
  85 {
  86   clib_bihash_kv_8_16_t *v = va_arg (*args, clib_bihash_kv_8_16_t *);
  87
  88   s =
  89     format (s, "key %llx value [%llx,%llx]", v->key, v->value[0], v->value[1]);
  90   return s;
  91 }
  92
  93 /** Compare two clib_bihash_kv_8_16_t instances
  94     @param a - first key
  95     @param b - second key
  96 */
  97 static inline int
  98 clib_bihash_key_compare_8_16 (u64 a, u64 b)
  99 {
 100   return a == b;
 101 }
 102
 103 #undef __included_bihash_template_h__
 104 #include <vppinfra/bihash_template.h>
 105
 106 #endif /* __included_bihash_8_16_h__ */
 107
 108 /*
 109  * fd.io coding-style-patch-verification: ON
 110  *
 111  * Local Variables:
 112  * eval: (c-set-style "gnu")
 113  * End:
 114  */