ofproto: Inline actions in struct rule_actions.
[sliver-openvswitch.git] / tests / test-hash.c
1 /*
2  * Copyright (c) 2009, 2012, 2014 Nicira, 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
17 #include <config.h>
18 #include <inttypes.h>
19 #include <stdio.h>
20 #include <stdlib.h>
21 #include <string.h>
22 #include "hash.h"
23 #include "jhash.h"
24 #include "ovstest.h"
25
26 #undef NDEBUG
27 #include <assert.h>
28
29 static void
30 set_bit(uint32_t array[3], int bit)
31 {
32     assert(bit >= 0 && bit <= 96);
33     memset(array, 0, sizeof(uint32_t) * 3);
34     if (bit < 96) {
35         array[bit / 32] = UINT32_C(1) << (bit % 32);
36     }
37 }
38
39 static uint32_t
40 hash_words_cb(uint32_t input)
41 {
42     return hash_words(&input, 1, 0);
43 }
44
45 static uint32_t
46 jhash_words_cb(uint32_t input)
47 {
48     return jhash_words(&input, 1, 0);
49 }
50
51 static uint32_t
52 hash_int_cb(uint32_t input)
53 {
54     return hash_int(input, 0);
55 }
56
57 static void
58 check_word_hash(uint32_t (*hash)(uint32_t), const char *name,
59                 int min_unique)
60 {
61     int i, j;
62
63     for (i = 0; i <= 32; i++) {
64         uint32_t in1 = i < 32 ? UINT32_C(1) << i : 0;
65         for (j = i + 1; j <= 32; j++) {
66             uint32_t in2 = j < 32 ? UINT32_C(1) << j : 0;
67             uint32_t out1 = hash(in1);
68             uint32_t out2 = hash(in2);
69             const uint32_t unique_mask = (UINT32_C(1) << min_unique) - 1;
70             int ofs;
71             for (ofs = 0; ofs < 32 - min_unique; ofs++) {
72                 uint32_t bits1 = (out1 >> ofs) & unique_mask;
73                 uint32_t bits2 = (out2 >> ofs) & unique_mask;
74                 if (bits1 == bits2) {
75                     printf("Partial collision for '%s':\n", name);
76                     printf("%s(%08"PRIx32") = %08"PRIx32"\n", name, in1, out1);
77                     printf("%s(%08"PRIx32") = %08"PRIx32"\n", name, in2, out2);
78                     printf("%d bits of output starting at bit %d "
79                            "are both 0x%"PRIx32"\n", min_unique, ofs, bits1);
80                     exit(1);
81                 }
82             }
83         }
84     }
85 }
86
87 static void
88 check_3word_hash(uint32_t (*hash)(const uint32_t[], size_t, uint32_t),
89                  const char *name)
90 {
91     int i, j;
92
93     for (i = 0; i <= 96; i++) {
94         for (j = i + 1; j <= 96; j++) {
95             uint32_t in1[3], in2[3];
96             uint32_t out1, out2;
97             const int min_unique = 12;
98             const uint32_t unique_mask = (UINT32_C(1) << min_unique) - 1;
99
100             set_bit(in1, i);
101             set_bit(in2, j);
102             out1 = hash(in1, 3, 0);
103             out2 = hash(in2, 3, 0);
104             if ((out1 & unique_mask) == (out2 & unique_mask)) {
105                 printf("%s has a partial collision:\n", name);
106                 printf("hash(1 << %d) == %08"PRIx32"\n", i, out1);
107                 printf("hash(1 << %d) == %08"PRIx32"\n", j, out2);
108                 printf("The low-order %d bits of output are both "
109                        "0x%"PRIx32"\n", min_unique, out1 & unique_mask);
110             }
111         }
112     }
113 }
114
115 static void
116 test_hash_main(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
117 {
118     /* Check that all hashes computed with hash_words with one 1-bit (or no
119      * 1-bits) set within a single 32-bit word have different values in all
120      * 11-bit consecutive runs.
121      *
122      * Given a random distribution, the probability of at least one collision
123      * in any set of 11 bits is approximately
124      *
125      *                      1 - ((2**11 - 1)/2**11)**C(33,2)
126      *                   == 1 - (2047/2048)**528
127      *                   =~ 0.22
128      *
129      * There are 21 ways to pick 11 consecutive bits in a 32-bit word, so if we
130      * assumed independence then the chance of having no collisions in any of
131      * those 11-bit runs would be (1-0.22)**21 =~ .0044.  Obviously
132      * independence must be a bad assumption :-)
133      */
134     check_word_hash(hash_words_cb, "hash_words", 11);
135     check_word_hash(jhash_words_cb, "jhash_words", 11);
136
137     /* Check that all hash functions of with one 1-bit (or no 1-bits) set
138      * within three 32-bit words have different values in their lowest 12
139      * bits.
140      *
141      * Given a random distribution, the probability of at least one collision
142      * in 12 bits is approximately
143      *
144      *                      1 - ((2**12 - 1)/2**12)**C(97,2)
145      *                   == 1 - (4095/4096)**4656
146      *                   =~ 0.68
147      *
148      * so we are doing pretty well to not have any collisions in 12 bits.
149      */
150     check_3word_hash(hash_words, "hash_words");
151     check_3word_hash(jhash_words, "jhash_words");
152
153     /* Check that all hashes computed with hash_int with one 1-bit (or no
154      * 1-bits) set within a single 32-bit word have different values in all
155      * 12-bit consecutive runs.
156      *
157      * Given a random distribution, the probability of at least one collision
158      * in any set of 12 bits is approximately
159      *
160      *                      1 - ((2**12 - 1)/2**12)**C(33,2)
161      *                   == 1 - (4,095/4,096)**528
162      *                   =~ 0.12
163      *
164      * There are 20 ways to pick 12 consecutive bits in a 32-bit word, so if we
165      * assumed independence then the chance of having no collisions in any of
166      * those 12-bit runs would be (1-0.12)**20 =~ 0.078.  This refutes our
167      * assumption of independence, which makes it seem like a good hash
168      * function.
169      */
170     check_word_hash(hash_int_cb, "hash_int", 12);
171 }
172
173 OVSTEST_REGISTER("test-hash", test_hash_main);