bf7c2bb86e34708fc2a7fef58862d10b124534ae
[folly.git] / folly / test / SpookyHashV2Test.cpp
1 /*
2  * Copyright 2013 Facebook, Inc.
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 // SpookyHash: a 128-bit noncryptographic hash function
17 // By Bob Jenkins, public domain
18
19 #ifndef __STDC_FORMAT_MACROS
20 #define __STDC_FORMAT_MACROS 1
21 #endif
22
23 #include "folly/SpookyHashV2.h"
24 #include "folly/Benchmark.h"
25
26 #include <cinttypes>
27 #include <cstdio>
28 #include <cstddef>
29 #include <cstring>
30 #include <cstdlib>
31 #include <ctime>
32
33 using namespace ::folly::hash;
34
35 static bool failed = false;
36
37 static uint64_t GetTickCount() {
38   timespec ts;
39   clock_gettime(CLOCK_REALTIME, &ts);
40   return ts.tv_sec * 1000 + ts.tv_nsec / 1000000;  // milliseconds
41 }
42
43 class Random
44 {
45 public:
46     inline uint64_t Value()
47     {
48         uint64_t e = m_a - Rot64(m_b, 23);
49         m_a = m_b ^ Rot64(m_c, 16);
50         m_b = m_c + Rot64(m_d, 11);
51         m_c = m_d + e;
52         m_d = e + m_a;
53         return m_d;
54     }
55
56     inline void Init( uint64_t seed)
57     {
58         m_a = 0xdeadbeef;
59         m_b = m_c = m_d = seed;
60         for (int i=0; i<20; ++i)
61             (void)Value();
62     }
63
64 private:
65     static inline uint64_t Rot64(uint64_t x, int k)
66     {
67         return (x << k) | (x >> (64-(k)));
68     }
69
70     uint64_t m_a;
71     uint64_t m_b;
72     uint64_t m_c;
73     uint64_t m_d;
74 };
75
76 // fastest conceivable hash function (for comparison)
77 static void Add(const void *data, size_t length, uint64_t *hash1, uint64_t *hash2)
78 {
79     uint64_t *p64 = (uint64_t *)data;
80     uint64_t *end = p64 + length/8;
81     uint64_t hash = *hash1 + *hash2;
82     while (p64 < end)
83     {
84       hash += *p64;
85       ++p64;
86     }
87     *hash1 = hash;
88     *hash2 = hash;
89 }
90
91 #define BUFSIZE (512)
92 void TestResults()
93 {
94     printf("\ntesting results ...\n");
95     static const uint64_t expected[BUFSIZE] = {
96       0x6bf50919,0x70de1d26,0xa2b37298,0x35bc5fbf,0x8223b279,0x5bcb315e,0x53fe88a1,0xf9f1a233,
97       0xee193982,0x54f86f29,0xc8772d36,0x9ed60886,0x5f23d1da,0x1ed9f474,0xf2ef0c89,0x83ec01f9,
98       0xf274736c,0x7e9ac0df,0xc7aed250,0xb1015811,0xe23470f5,0x48ac20c4,0xe2ab3cd5,0x608f8363,
99       0xd0639e68,0xc4e8e7ab,0x863c7c5b,0x4ea63579,0x99ae8622,0x170c658b,0x149ba493,0x027bca7c,
100       0xe5cfc8b6,0xce01d9d7,0x11103330,0x5d1f5ed4,0xca720ecb,0xef408aec,0x733b90ec,0x855737a6,
101       0x9856c65f,0x647411f7,0x50777c74,0xf0f1a8b7,0x9d7e55a5,0xc68dd371,0xfc1af2cc,0x75728d0a,
102       0x390e5fdc,0xf389b84c,0xfb0ccf23,0xc95bad0e,0x5b1cb85a,0x6bdae14f,0x6deb4626,0x93047034,
103       0x6f3266c6,0xf529c3bd,0x396322e7,0x3777d042,0x1cd6a5a2,0x197b402e,0xc28d0d2b,0x09c1afb4,
104
105       0x069c8bb7,0x6f9d4e1e,0xd2621b5c,0xea68108d,0x8660cb8f,0xd61e6de6,0x7fba15c7,0xaacfaa97,
106       0xdb381902,0x4ea22649,0x5d414a1e,0xc3fc5984,0xa0fc9e10,0x347dc51c,0x37545fb6,0x8c84b26b,
107       0xf57efa5d,0x56afaf16,0xb6e1eb94,0x9218536a,0xe3cc4967,0xd3275ef4,0xea63536e,0x6086e499,
108       0xaccadce7,0xb0290d82,0x4ebfd0d6,0x46ccc185,0x2eeb10d3,0x474e3c8c,0x23c84aee,0x3abae1cb,
109       0x1499b81a,0xa2993951,0xeed176ad,0xdfcfe84c,0xde4a961f,0x4af13fe6,0xe0069c42,0xc14de8f5,
110       0x6e02ce8f,0x90d19f7f,0xbca4a484,0xd4efdd63,0x780fd504,0xe80310e3,0x03abbc12,0x90023849,
111       0xd6f6fb84,0xd6b354c5,0x5b8575f0,0x758f14e4,0x450de862,0x90704afb,0x47209a33,0xf226b726,
112       0xf858dab8,0x7c0d6de9,0xb05ce777,0xee5ff2d4,0x7acb6d5c,0x2d663f85,0x41c72a91,0x82356bf2,
113
114       0x94e948ec,0xd358d448,0xeca7814d,0x78cd7950,0xd6097277,0x97782a5d,0xf43fc6f4,0x105f0a38,
115       0x9e170082,0x4bfe566b,0x4371d25f,0xef25a364,0x698eb672,0x74f850e4,0x4678ff99,0x4a290dc6,
116       0x3918f07c,0x32c7d9cd,0x9f28e0af,0x0d3c5a86,0x7bfc8a45,0xddf0c7e1,0xdeacb86b,0x970b3c5c,
117       0x5e29e199,0xea28346d,0x6b59e71b,0xf8a8a46a,0x862f6ce4,0x3ccb740b,0x08761e9e,0xbfa01e5f,
118       0xf17cfa14,0x2dbf99fb,0x7a0be420,0x06137517,0xe020b266,0xd25bfc61,0xff10ed00,0x42e6be8b,
119       0x029ef587,0x683b26e0,0xb08afc70,0x7c1fd59e,0xbaae9a70,0x98c8c801,0xb6e35a26,0x57083971,
120       0x90a6a680,0x1b44169e,0x1dce237c,0x518e0a59,0xccb11358,0x7b8175fb,0xb8fe701a,0x10d259bb,
121       0xe806ce10,0x9212be79,0x4604ae7b,0x7fa22a84,0xe715b13a,0x0394c3b2,0x11efbbae,0xe13d9e19,
122
123       0x77e012bd,0x2d05114c,0xaecf2ddd,0xb2a2b4aa,0xb9429546,0x55dce815,0xc89138f8,0x46dcae20,
124       0x1f6f7162,0x0c557ebc,0x5b996932,0xafbbe7e2,0xd2bd5f62,0xff475b9f,0x9cec7108,0xeaddcffb,
125       0x5d751aef,0xf68f7bdf,0xf3f4e246,0x00983fcd,0x00bc82bb,0xbf5fd3e7,0xe80c7e2c,0x187d8b1f,
126       0xefafb9a7,0x8f27a148,0x5c9606a9,0xf2d2be3e,0xe992d13a,0xe4bcd152,0xce40b436,0x63d6a1fc,
127       0xdc1455c4,0x64641e39,0xd83010c9,0x2d535ae0,0x5b748f3e,0xf9a9146b,0x80f10294,0x2859acd4,
128       0x5fc846da,0x56d190e9,0x82167225,0x98e4daba,0xbf7865f3,0x00da7ae4,0x9b7cd126,0x644172f8,
129       0xde40c78f,0xe8803efc,0xdd331a2b,0x48485c3c,0x4ed01ddc,0x9c0b2d9e,0xb1c6e9d7,0xd797d43c,
130       0x274101ff,0x3bf7e127,0x91ebbc56,0x7ffeb321,0x4d42096f,0xd6e9456a,0x0bade318,0x2f40ee0b,
131
132       0x38cebf03,0x0cbc2e72,0xbf03e704,0x7b3e7a9a,0x8e985acd,0x90917617,0x413895f8,0xf11dde04,
133       0xc66f8244,0xe5648174,0x6c420271,0x2469d463,0x2540b033,0xdc788e7b,0xe4140ded,0x0990630a,
134       0xa54abed4,0x6e124829,0xd940155a,0x1c8836f6,0x38fda06c,0x5207ab69,0xf8be9342,0x774882a8,
135       0x56fc0d7e,0x53a99d6e,0x8241f634,0x9490954d,0x447130aa,0x8cc4a81f,0x0868ec83,0xc22c642d,
136       0x47880140,0xfbff3bec,0x0f531f41,0xf845a667,0x08c15fb7,0x1996cd81,0x86579103,0xe21dd863,
137       0x513d7f97,0x3984a1f1,0xdfcdc5f4,0x97766a5e,0x37e2b1da,0x41441f3f,0xabd9ddba,0x23b755a9,
138       0xda937945,0x103e650e,0x3eef7c8f,0x2760ff8d,0x2493a4cd,0x1d671225,0x3bf4bd4c,0xed6e1728,
139       0xc70e9e30,0x4e05e529,0x928d5aa6,0x164d0220,0xb5184306,0x4bd7efb3,0x63830f11,0xf3a1526c,
140
141       0xf1545450,0xd41d5df5,0x25a5060d,0x77b368da,0x4fe33c7e,0xeae09021,0xfdb053c4,0x2930f18d,
142       0xd37109ff,0x8511a781,0xc7e7cdd7,0x6aeabc45,0xebbeaeaa,0x9a0c4f11,0xda252cbb,0x5b248f41,
143       0x5223b5eb,0xe32ab782,0x8e6a1c97,0x11d3f454,0x3e05bd16,0x0059001d,0xce13ac97,0xf83b2b4c,
144       0x71db5c9a,0xdc8655a6,0x9e98597b,0x3fcae0a2,0x75e63ccd,0x076c72df,0x4754c6ad,0x26b5627b,
145       0xd818c697,0x998d5f3d,0xe94fc7b2,0x1f49ad1a,0xca7ff4ea,0x9fe72c05,0xfbd0cbbf,0xb0388ceb,
146       0xb76031e3,0xd0f53973,0xfb17907c,0xa4c4c10f,0x9f2d8af9,0xca0e56b0,0xb0d9b689,0xfcbf37a3,
147       0xfede8f7d,0xf836511c,0x744003fc,0x89eba576,0xcfdcf6a6,0xc2007f52,0xaaaf683f,0x62d2f9ca,
148       0xc996f77f,0x77a7b5b3,0x8ba7d0a4,0xef6a0819,0xa0d903c0,0x01b27431,0x58fffd4c,0x4827f45c,
149
150       0x44eb5634,0xae70edfc,0x591c740b,0x478bf338,0x2f3b513b,0x67bf518e,0x6fef4a0c,0x1e0b6917,
151       0x5ac0edc5,0x2e328498,0x077de7d5,0x5726020b,0x2aeda888,0x45b637ca,0xcf60858d,0x3dc91ae2,
152       0x3e6d5294,0xe6900d39,0x0f634c71,0x827a5fa4,0xc713994b,0x1c363494,0x3d43b615,0xe5fe7d15,
153       0xf6ada4f2,0x472099d5,0x04360d39,0x7f2a71d0,0x88a4f5ff,0x2c28fac5,0x4cd64801,0xfd78dd33,
154       0xc9bdd233,0x21e266cc,0x9bbf419d,0xcbf7d81d,0x80f15f96,0x04242657,0x53fb0f66,0xded11e46,
155       0xf2fdba97,0x8d45c9f1,0x4eeae802,0x17003659,0xb9db81a7,0xe734b1b2,0x9503c54e,0xb7c77c3e,
156       0x271dd0ab,0xd8b906b5,0x0d540ec6,0xf03b86e0,0x0fdb7d18,0x95e261af,0xad9ec04e,0x381f4a64,
157       0xfec798d7,0x09ea20be,0x0ef4ca57,0x1e6195bb,0xfd0da78b,0xcea1653b,0x157d9777,0xf04af50f,
158
159       0xad7baa23,0xd181714a,0x9bbdab78,0x6c7d1577,0x645eb1e7,0xa0648264,0x35839ca6,0x2287ef45,
160       0x32a64ca3,0x26111f6f,0x64814946,0xb0cddaf1,0x4351c59e,0x1b30471c,0xb970788a,0x30e9f597,
161       0xd7e58df1,0xc6d2b953,0xf5f37cf4,0x3d7c419e,0xf91ecb2d,0x9c87fd5d,0xb22384ce,0x8c7ac51c,
162       0x62c96801,0x57e54091,0x964536fe,0x13d3b189,0x4afd1580,0xeba62239,0xb82ea667,0xae18d43a,
163       0xbef04402,0x1942534f,0xc54bf260,0x3c8267f5,0xa1020ddd,0x112fcc8a,0xde596266,0xe91d0856,
164       0xf300c914,0xed84478e,0x5b65009e,0x4764da16,0xaf8e07a2,0x4088dc2c,0x9a0cad41,0x2c3f179b,
165       0xa67b83f7,0xf27eab09,0xdbe10e28,0xf04c911f,0xd1169f87,0x8e1e4976,0x17f57744,0xe4f5a33f,
166       0x27c2e04b,0x0b7523bd,0x07305776,0xc6be7503,0x918fa7c9,0xaf2e2cd9,0x82046f8e,0xcc1c8250
167     };
168
169     uint8_t buf[BUFSIZE];
170     uint32_t saw[BUFSIZE];
171     for (int i=0; i<BUFSIZE; ++i)
172     {
173         buf[i] = i+128;
174         saw[i] = SpookyHashV2::Hash32(buf, i, 0);
175         if (saw[i] != expected[i])
176         {
177             printf("%3d: saw 0x%.8x, expected 0x%.8" PRIx64 "\n", i, saw[i],
178                    expected[i]);
179             failed = true;
180         }
181     }
182 }
183 #undef BUFSIZE
184
185
186 #define NUMBUF (1<<10)
187 #define BUFSIZE (1<<20)
188 void DoTimingBig(int seed)
189 {
190     printf("\ntesting time to hash 2^^30 bytes ...\n");
191
192     char *buf[NUMBUF];
193     for (int i=0; i<NUMBUF; ++i)
194     {
195         buf[i] = (char *)malloc(BUFSIZE);
196         memset(buf[i], (char)seed, BUFSIZE);
197     }
198
199     uint64_t a = GetTickCount();
200     uint64_t hash1 = seed;
201     uint64_t hash2 = seed;
202     for (uint64_t i=0; i<NUMBUF; ++i)
203     {
204         SpookyHashV2::Hash128(buf[i], BUFSIZE, &hash1, &hash2);
205     }
206     uint64_t z = GetTickCount();
207     printf("SpookyHashV2::Hash128, uncached: time is "
208            "%4" PRId64 " milliseconds\n", z-a);
209
210     a = GetTickCount();
211     for (uint64_t i=0; i<NUMBUF; ++i)
212     {
213         Add(buf[i], BUFSIZE, &hash1, &hash2);
214     }
215     z = GetTickCount();
216     printf("Addition           , uncached: time is %4" PRId64 " milliseconds\n",
217            z-a);
218
219     a = GetTickCount();
220     for (uint64_t i=0; i<NUMBUF*BUFSIZE/1024; ++i)
221     {
222         SpookyHashV2::Hash128(buf[0], 1024, &hash1, &hash2);
223     }
224     z = GetTickCount();
225     printf("SpookyHashV2::Hash128,   cached: time is "
226            "%4" PRId64 " milliseconds\n", z-a);
227
228     a = GetTickCount();
229     for (uint64_t i=0; i<NUMBUF*BUFSIZE/1024; ++i)
230     {
231         Add(buf[0], 1024, &hash1, &hash2);
232     }
233     z = GetTickCount();
234     printf("Addition           ,   cached: time is %4" PRId64 " milliseconds\n",
235            z-a);
236
237     for (int i=0; i<NUMBUF; ++i)
238     {
239         free(buf[i]);
240         buf[i] = 0;
241     }
242 }
243 #undef NUMBUF
244 #undef BUFSIZE
245
246
247 #define BUFSIZE (1<<14)
248 #define NUMITER 10000000
249 void DoTimingSmall(int seed)
250 {
251     printf("\ntesting timing of hashing up to %d cached aligned bytes %d "
252            "times ...\n", BUFSIZE, NUMITER);
253
254     uint64_t buf[BUFSIZE/8];
255     for (int i=0; i<BUFSIZE/8; ++i)
256     {
257         buf[i] = i+seed;
258     }
259
260     for (int i=1; i <= BUFSIZE; i <<= 1)
261     {
262         uint64_t a = GetTickCount();
263         uint64_t hash1 = seed;
264         uint64_t hash2 = seed+i;
265         for (int j=0; j<NUMITER; ++j)
266         {
267             SpookyHashV2::Hash128((char *)buf, i, &hash1, &hash2);
268         }
269         uint64_t z = GetTickCount();
270         printf("%d bytes: hash is %.16" PRIx64 " %.16" PRIx64 ", "
271                "time is %" PRId64 "\n", i, hash1, hash2, z-a);
272     }
273 }
274 #undef BUFSIZE
275
276 #define BUFSIZE 1024
277 void TestAlignment()
278 {
279     printf("\ntesting alignment ...\n");
280
281     char buf[BUFSIZE];
282     uint64_t hash[8];
283     for (int i=0; i<BUFSIZE-16; ++i)
284     {
285         for (int j=0; j<8; ++j)
286         {
287             buf[j] = (char)i+j;
288             for (int k=1; k<=i; ++k)
289             {
290                 buf[j+k] = k;
291             }
292             buf[j+i+1] = (char)i+j;
293             hash[j] = SpookyHashV2::Hash64((const void *)(buf+j+1), i, 0);
294         }
295         for (int j=1; j<8; ++j)
296         {
297             if (hash[0] != hash[j])
298             {
299                 printf("alignment problems: %d %d\n", i, j);
300                 failed = true;
301             }
302         }
303     }
304 }
305 #undef BUFSIZE
306
307 // test that all deltas of one or two input bits affect all output bits
308 #define BUFSIZE 256
309 #define TRIES 50
310 #define MEASURES 6
311 void TestDeltas(int seed)
312 {
313     printf("\nall 1 or 2 bit input deltas get %d tries to flip every output "
314            "bit ...\n", TRIES);
315
316     Random random;
317     random.Init((uint64_t)seed);
318
319     // for messages 0..BUFSIZE-1 bytes
320     for (int h=0; h<BUFSIZE; ++h)
321     {
322         int maxk = 0;
323         // first bit to set
324         for (int i=0; i<h*8; ++i)
325         {
326             // second bit to set, or don't have a second bit
327             for (int j=0; j<=i; ++j)
328             {
329                 uint64_t measure[MEASURES][2];
330                 uint64_t counter[MEASURES][2];
331                 for (int l=0; l<2; ++l)
332                 {
333                     for (int m=0; m<MEASURES; ++m)
334                     {
335                         counter[m][l] = 0;
336                     }
337                 }
338
339                 // try to hit every output bit TRIES times
340                 int k;
341                 for (k=0; k<TRIES; ++k)
342                 {
343                     uint8_t buf1[BUFSIZE];
344                     uint8_t buf2[BUFSIZE];
345                     int done = 1;
346                     for (int l=0; l<h; ++l)
347                     {
348                         buf1[l] = buf2[l] = random.Value();
349                     }
350                     buf1[i/8] ^= (1 << (i%8));
351                     if (j != i)
352                     {
353                         buf1[j/8] ^= (1 << (j%8));
354                     }
355                     SpookyHashV2::Hash128(buf1, h, &measure[0][0], &measure[0][1]);
356                     SpookyHashV2::Hash128(buf2, h, &measure[1][0], &measure[1][1]);
357                     for (int l=0; l<2; ++l) {
358                         measure[2][l] = measure[0][l] ^ measure[1][l];
359                         measure[3][l] = ~(measure[0][l] ^ measure[1][l]);
360                         measure[4][l] = measure[0][l] - measure[1][l];
361                         measure[4][l] ^= (measure[4][l]>>1);
362                         measure[5][l] = measure[0][l] + measure[1][l];
363                         measure[5][l] ^= (measure[4][l]>>1);
364                     }
365                     for (int l=0; l<2; ++l)
366                     {
367                         for (int m=0; m<MEASURES; ++m)
368                         {
369                             counter[m][l] |= measure[m][l];
370                             if (~counter[m][l]) done = 0;
371                         }
372                     }
373                     if (done) break;
374                 }
375                 if (k == TRIES)
376                 {
377                     printf("failed %d %d %d\n", h, i, j);
378                     failed = true;
379                 }
380                 else if (k > maxk)
381                 {
382                     maxk = k;
383                 }
384             }
385         }
386         printf("passed for buffer size %d  max %d\n", h, maxk);
387     }
388 }
389 #undef BUFSIZE
390 #undef TRIES
391 #undef MEASURES
392
393
394 // test that hashing pieces has the same behavior as hashing the whole
395 #define BUFSIZE 1024
396 void TestPieces()
397 {
398     printf("\ntesting pieces ...\n");
399     char buf[BUFSIZE];
400     for (int i=0; i<BUFSIZE; ++i)
401     {
402         buf[i] = i;
403     }
404     for (int i=0; i<BUFSIZE; ++i)
405     {
406         uint64_t a,b,c,d,seed1=1,seed2=2;
407         SpookyHashV2 state;
408
409         // all as one call
410         a = seed1;
411         b = seed2;
412         SpookyHashV2::Hash128(buf, i, &a, &b);
413
414         // all as one piece
415         c = 0xdeadbeefdeadbeef;
416         d = 0xbaceba11baceba11;
417         state.Init(seed1, seed2);
418         state.Update(buf, i);
419         state.Final(&c, &d);
420
421         if (a != c)
422         {
423             printf("wrong a %d: %.16" PRIx64 " %.16" PRIx64 "\n", i, a,c);
424             failed = true;
425         }
426         if (b != d)
427         {
428             printf("wrong b %d: %.16" PRIx64 " %.16" PRIx64 "\n", i, b,d);
429             failed = true;
430         }
431
432         // all possible two consecutive pieces
433         for (int j=0; j<i; ++j)
434         {
435             c = seed1;
436             d = seed2;
437             state.Init(c, d);
438             state.Update(&buf[0], j);
439             state.Update(&buf[j], i-j);
440             state.Final(&c, &d);
441             if (a != c)
442             {
443                 printf("wrong a %d %d: %.16" PRIx64 " %.16" PRIx64 "\n",
444                        j, i, a,c);
445                 failed = true;
446             }
447             if (b != d)
448             {
449                 printf("wrong b %d %d: %.16" PRIx64 " %.16" PRIx64 "\n",
450                        j, i, b,d);
451                 failed = true;
452             }
453         }
454     }
455 }
456 #undef BUFSIZE
457
458 int main(int argc, const char **argv)
459 {
460     TestResults();
461     TestAlignment();
462     TestPieces();
463     DoTimingBig(argc);
464     // tudorb@fb.com: Commented out slow tests
465 #if 0
466     DoTimingSmall(argc);
467     TestDeltas(argc);
468 #endif
469     return failed;
470 }