src/vppinfra/bihash_vec8_8.h

   1 /*
   2  * Copyright (c) 2017 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
  23 #define BIHASH_TYPE _vec8_8
  24 #define BIHASH_KVP_PER_PAGE 4
  25 #define BIHASH_KVP_AT_BUCKET_LEVEL 0
  26 #define BIHASH_LAZY_INSTANTIATE 1
  27 #define BIHASH_BUCKET_PREFETCH_CACHE_LINES 1
  28
  29 #ifndef __included_bihash_vec8_8_h__
  30 #define __included_bihash_vec8_8_h__
  31
  32 #include <vppinfra/heap.h>
  33 #include <vppinfra/format.h>
  34 #include <vppinfra/pool.h>
  35 #include <vppinfra/xxhash.h>
  36 #include <vppinfra/crc32.h>
  37
  38 /** 8 octet key, 8 octet key value pair */
  39 typedef struct
  40 {
  41   u64 key;                      /**< the key */
  42   u64 value;                    /**< the value */
  43 } clib_bihash_kv_vec8_8_t;
  44
  45 static inline void
  46 clib_bihash_mark_free_vec8_8 (clib_bihash_kv_vec8_8_t *v)
  47 {
  48   v->value = 0xFEEDFACE8BADF00DULL;
  49 }
  50
  51 /** Decide if a clib_bihash_kv_vec8_8_t instance is free
  52     @param v- pointer to the (key,value) pair
  53 */
  54 static inline int
  55 clib_bihash_is_free_vec8_8 (clib_bihash_kv_vec8_8_t * v)
  56 {
  57   if (v->value == 0xFEEDFACE8BADF00DULL)
  58     return 1;
  59   return 0;
  60 }
  61
  62 /** Hash a clib_bihash_kv_vec8_8_t instance
  63     @param v - pointer to the (key,value) pair, hash the key (only)
  64 */
  65 static inline u64
  66 clib_bihash_hash_vec8_8 (clib_bihash_kv_vec8_8_t * v)
  67 {
  68   u8 *keyp = (u8 *) (v->key);
  69   /* Note: to torture-test linear scan, make this fn return a constant */
  70 #ifdef clib_crc32c_uses_intrinsics
  71   return clib_crc32c (keyp, vec_len (keyp));
  72 #else
  73   {
  74     int i, j;
  75     u64 sum = 0;
  76
  77     for (i = 0, j = 0; i < vec_len (keyp); i++)
  78       {
  79         sum ^= keyp[i] << (j * 8);
  80         j++;
  81         if (j == 4)
  82           j = 0;
  83       }
  84
  85     return clib_xxhash (sum);
  86   }
  87 #endif
  88 }
  89
  90 /** Format a clib_bihash_kv_vec8_8_t instance
  91     @param s - u8 * vector under construction
  92     @param args (vararg) - the (key,value) pair to format
  93     @return s - the u8 * vector under construction
  94 */
  95 static inline u8 *
  96 format_bihash_kvp_vec8_8 (u8 * s, va_list * args)
  97 {
  98   clib_bihash_kv_vec8_8_t *v = va_arg (*args, clib_bihash_kv_vec8_8_t *);
  99
 100   s = format (s, "key %U value %llu",
 101               format_hex_bytes, v->key, vec_len ((u8 *) (v->key)), v->value);
 102   return s;
 103 }
 104
 105 /** Compare two clib_bihash_kv_vec8_8_t instances
 106     @param a - first key
 107     @param b - second key
 108 */
 109 static inline int
 110 clib_bihash_key_compare_vec8_8 (u64 a_arg, u64 b_arg)
 111 {
 112   u8 *a = (u8 *) a_arg;
 113   u8 *b = (u8 *) b_arg;
 114
 115   if (a_arg == ~0ULL || b_arg == ~0ULL)
 116     return 0;
 117
 118   if (vec_len (a) != vec_len (b))
 119     return 0;
 120
 121   return memcmp (a, b, vec_len (a)) == 0;
 122 }
 123
 124 #undef __included_bihash_template_h__
 125 #include <vppinfra/bihash_template.h>
 126
 127 #endif /* __included_bihash_vec8_8_h__ */
 128
 129 /*
 130  * fd.io coding-style-patch-verification: ON
 131  *
 132  * Local Variables:
 133  * eval: (c-set-style "gnu")
 134  * End:
 135  */