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