lib/hash.h

   1 /*
   2  * Copyright (c) 2008, 2009 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 #ifndef HASH_H
  17 #define HASH_H 1
  18
  19 #include <stddef.h>
  20 #include <stdint.h>
  21 #include <string.h>
  22 #include "util.h"
  23
  24 /* This is the public domain lookup3 hash by Bob Jenkins from
  25  * http://burtleburtle.net/bob/c/lookup3.c, modified for style. */
  26
  27 #define HASH_ROT(x, k) (((x) << (k)) | ((x) >> (32 - (k))))
  28
  29 #define HASH_MIX(a, b, c)                       \
  30     do {                                        \
  31       a -= c; a ^= HASH_ROT(c,  4); c += b;     \
  32       b -= a; b ^= HASH_ROT(a,  6); a += c;     \
  33       c -= b; c ^= HASH_ROT(b,  8); b += a;     \
  34       a -= c; a ^= HASH_ROT(c, 16); c += b;     \
  35       b -= a; b ^= HASH_ROT(a, 19); a += c;     \
  36       c -= b; c ^= HASH_ROT(b,  4); b += a;     \
  37     } while (0)
  38
  39 #define HASH_FINAL(a, b, c)                     \
  40     do {                                        \
  41       c ^= b; c -= HASH_ROT(b, 14);             \
  42       a ^= c; a -= HASH_ROT(c, 11);             \
  43       b ^= a; b -= HASH_ROT(a, 25);             \
  44       c ^= b; c -= HASH_ROT(b, 16);             \
  45       a ^= c; a -= HASH_ROT(c,  4);             \
  46       b ^= a; b -= HASH_ROT(a, 14);             \
  47       c ^= b; c -= HASH_ROT(b, 24);             \
  48     } while (0)
  49
  50 uint32_t hash_words(const uint32_t *, size_t n_word, uint32_t basis);
  51 uint32_t hash_2words(const uint32_t *, uint32_t basis);
  52 uint32_t hash_bytes(const void *, size_t n_bytes, uint32_t basis);
  53
  54 static inline uint32_t hash_string(const char *s, uint32_t basis)
  55 {
  56     return hash_bytes(s, strlen(s), basis);
  57 }
  58
  59 /* This is Bob Jenkins' integer hash from
  60  * http://burtleburtle.net/bob/hash/integer.html, modified for style. */
  61 static inline uint32_t hash_int(uint32_t x, uint32_t basis)
  62 {
  63     x -= x << 6;
  64     x ^= x >> 17;
  65     x -= x << 9;
  66     x ^= x << 4;
  67     x -= x << 3;
  68     x ^= x << 10;
  69     x ^= x >> 15;
  70     return x + basis;
  71 }
  72
  73 static inline uint32_t hash_double(double x, uint32_t basis)
  74 {
  75     BUILD_ASSERT_DECL(sizeof x == 8);
  76     return hash_2words((const uint32_t *) &x, basis);
  77 }
  78
  79 static inline uint32_t hash_pointer(const void *p, uint32_t basis)
  80 {
  81     /* Often pointers are hashed simply by casting to integer type, but that
  82      * has pitfalls since the lower bits of a pointer are often all 0 for
  83      * alignment reasons.  It's hard to guess where the entropy really is, so
  84      * we give up here and just use a high-quality hash function.
  85      *
  86      * The double cast suppresses a warning on 64-bit systems about casting to
  87      * an integer to different size.  That's OK in this case, since most of the
  88      * entropy in the pointer is almost certainly in the lower 32 bits. */
  89     return hash_int((uint32_t) (uintptr_t) p, basis);
  90 }
  91
  92 #endif /* hash.h */