src/vppinfra/bihash_8_8.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
  20 #define BIHASH_TYPE _8_8
  21 #define BIHASH_KVP_PER_PAGE 4
  22
  23 #ifndef __included_bihash_8_8_h__
  24 #define __included_bihash_8_8_h__
  25
  26 #include <vppinfra/heap.h>
  27 #include <vppinfra/format.h>
  28 #include <vppinfra/pool.h>
  29 #include <vppinfra/xxhash.h>
  30 #include <vppinfra/crc32.h>
  31
  32 /** 8 octet key, 8 octet key value pair */
  33 typedef struct
  34 {
  35   u64 key;                      /**< the key */
  36   u64 value;                    /**< the value */
  37 } clib_bihash_kv_8_8_t;
  38
  39 /** Decide if a clib_bihash_kv_8_8_t instance is free
  40     @param v- pointer to the (key,value) pair
  41 */
  42 static inline int
  43 clib_bihash_is_free_8_8 (clib_bihash_kv_8_8_t * v)
  44 {
  45   if (v->key == ~0ULL && v->value == ~0ULL)
  46     return 1;
  47   return 0;
  48 }
  49
  50 /** Hash a clib_bihash_kv_8_8_t instance
  51     @param v - pointer to the (key,value) pair, hash the key (only)
  52 */
  53 static inline u64
  54 clib_bihash_hash_8_8 (clib_bihash_kv_8_8_t * v)
  55 {
  56   /* Note: to torture-test linear scan, make this fn return a constant */
  57 #ifdef clib_crc32c_uses_intrinsics
  58   return clib_crc32c ((u8 *) & v->key, 8);
  59 #else
  60   return clib_xxhash (v->key);
  61 #endif
  62 }
  63
  64 /** Format a clib_bihash_kv_8_8_t instance
  65     @param s - u8 * vector under construction
  66     @param args (vararg) - the (key,value) pair to format
  67     @return s - the u8 * vector under construction
  68 */
  69 static inline u8 *
  70 format_bihash_kvp_8_8 (u8 * s, va_list * args)
  71 {
  72   clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
  73
  74   s = format (s, "key %llu value %llu", v->key, v->value);
  75   return s;
  76 }
  77
  78 /** Compare two clib_bihash_kv_8_8_t instances
  79     @param a - first key
  80     @param b - second key
  81 */
  82 static inline int
  83 clib_bihash_key_compare_8_8 (u64 a, u64 b)
  84 {
  85   return a == b;
  86 }
  87
  88 #undef __included_bihash_template_h__
  89 #include <vppinfra/bihash_template.h>
  90
  91 #endif /* __included_bihash_8_8_h__ */
  92
  93 /*
  94  * fd.io coding-style-patch-verification: ON
  95  *
  96  * Local Variables:
  97  * eval: (c-set-style "gnu")
  98  * End:
  99  */