ovsdb: Correct specification inconsistency between "lock" and "assert".
[openvswitch] / lib / hash.h
1 /*
2  * Copyright (c) 2008, 2009, 2010 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 <stdbool.h>
20 #include <stddef.h>
21 #include <stdint.h>
22 #include <string.h>
23 #include "util.h"
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 /* This is the public domain lookup3 hash by Bob Jenkins from
30  * http://burtleburtle.net/bob/c/lookup3.c, modified for style. */
31
32 #define HASH_ROT(x, k) (((x) << (k)) | ((x) >> (32 - (k))))
33
34 #define HASH_MIX(a, b, c)                       \
35     do {                                        \
36       a -= c; a ^= HASH_ROT(c,  4); c += b;     \
37       b -= a; b ^= HASH_ROT(a,  6); a += c;     \
38       c -= b; c ^= HASH_ROT(b,  8); b += a;     \
39       a -= c; a ^= HASH_ROT(c, 16); c += b;     \
40       b -= a; b ^= HASH_ROT(a, 19); a += c;     \
41       c -= b; c ^= HASH_ROT(b,  4); b += a;     \
42     } while (0)
43
44 #define HASH_FINAL(a, b, c)                     \
45     do {                                        \
46       c ^= b; c -= HASH_ROT(b, 14);             \
47       a ^= c; a -= HASH_ROT(c, 11);             \
48       b ^= a; b -= HASH_ROT(a, 25);             \
49       c ^= b; c -= HASH_ROT(b, 16);             \
50       a ^= c; a -= HASH_ROT(c,  4);             \
51       b ^= a; b -= HASH_ROT(a, 14);             \
52       c ^= b; c -= HASH_ROT(b, 24);             \
53     } while (0)
54
55 uint32_t hash_words(const uint32_t *, size_t n_word, uint32_t basis);
56 uint32_t hash_2words(uint32_t, uint32_t);
57 uint32_t hash_3words(uint32_t, uint32_t, uint32_t);
58 uint32_t hash_bytes(const void *, size_t n_bytes, uint32_t basis);
59
60 static inline uint32_t hash_string(const char *s, uint32_t basis)
61 {
62     return hash_bytes(s, strlen(s), basis);
63 }
64
65 /* This is Bob Jenkins' integer hash from
66  * http://burtleburtle.net/bob/hash/integer.html, modified for style.
67  *
68  * This hash is faster than hash_2words(), but it isn't as good when 'basis' is
69  * important.  So use this function for speed or hash_2words() for hash
70  * quality. */
71 static inline uint32_t hash_int(uint32_t x, uint32_t basis)
72 {
73     x -= x << 6;
74     x ^= x >> 17;
75     x -= x << 9;
76     x ^= x << 4;
77     x += basis;
78     x -= x << 3;
79     x ^= x << 10;
80     x ^= x >> 15;
81     return x;
82 }
83
84 /* An attempt at a useful 1-bit hash function.  Has not been analyzed for
85  * quality. */
86 static inline uint32_t hash_boolean(bool x, uint32_t basis)
87 {
88     const uint32_t P0 = 0xc2b73583;   /* This is hash_int(1, 0). */
89     const uint32_t P1 = 0xe90f1258;   /* This is hash_int(2, 0). */
90     return (x ? P0 : P1) ^ HASH_ROT(basis, 1);
91 }
92
93 static inline uint32_t hash_double(double x, uint32_t basis)
94 {
95     uint32_t value[2];
96     BUILD_ASSERT_DECL(sizeof x == sizeof value);
97
98     memcpy(value, &x, sizeof value);
99     return hash_3words(value[0], value[1], basis);
100 }
101
102 static inline uint32_t hash_pointer(const void *p, uint32_t basis)
103 {
104     /* Often pointers are hashed simply by casting to integer type, but that
105      * has pitfalls since the lower bits of a pointer are often all 0 for
106      * alignment reasons.  It's hard to guess where the entropy really is, so
107      * we give up here and just use a high-quality hash function.
108      *
109      * The double cast suppresses a warning on 64-bit systems about casting to
110      * an integer to different size.  That's OK in this case, since most of the
111      * entropy in the pointer is almost certainly in the lower 32 bits. */
112     return hash_int((uint32_t) (uintptr_t) p, basis);
113 }
114
115 #ifdef __cplusplus
116 }
117 #endif
118
119 #endif /* hash.h */