Branch data Line data Source code
1 : : // Copyright (c) The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <random.h>
6 : : #include <span.h>
7 : : #include <test/fuzz/util.h>
8 : : #include <util/bitset.h>
9 : :
10 : : #include <bitset>
11 : : #include <vector>
12 : :
13 : : namespace {
14 : :
15 : : /** Pop the first byte from a byte-span, and return it. */
16 : 2689292 : uint8_t ReadByte(FuzzBufferType& buffer)
17 : : {
18 [ + + ]: 2689292 : if (buffer.empty()) return 0;
19 : 2686621 : uint8_t ret = buffer.front();
20 : 2686621 : buffer = buffer.subspan(1);
21 : 2686621 : return ret;
22 : : }
23 : :
24 : : /** Perform a simulation fuzz test on BitSet type S. */
25 : : template<typename S>
26 : 3588 : void TestType(FuzzBufferType buffer)
27 : : {
28 : : /** This fuzz test's design is based on the assumption that the actual bits stored in the
29 : : * bitsets and their simulations do not matter for the purpose of detecting edge cases, thus
30 : : * these are taken from a deterministically-seeded RNG instead. To provide some level of
31 : : * variation however, pick the seed based on the buffer size and size of the chosen bitset. */
32 : 3588 : InsecureRandomContext rng(buffer.size() + 0x10000 * S::Size());
33 : :
34 : : using Sim = std::bitset<S::Size()>;
35 : : // Up to 4 real BitSets (initially 2).
36 : 3588 : std::vector<S> real(2);
37 : : // Up to 4 std::bitsets with the same corresponding contents.
38 [ + - ]: 3588 : std::vector<Sim> sim(2);
39 : :
40 : : /* Compare sim[idx] with real[idx], using all inspector operations. */
41 : 1145748 : auto compare_fn = [&](unsigned idx) {
42 : : /* iterators and operator[] */
43 [ + + + + : 571080 : auto it = real[idx].begin();
+ + ]
44 : 571080 : unsigned first = S::Size();
45 : 571080 : unsigned last = S::Size();
46 [ + + + + : 50754744 : for (unsigned i = 0; i < S::Size(); ++i) {
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + ]
47 [ + + + + : 50183664 : bool match = (it != real[idx].end()) && *it == i;
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + ]
48 [ - + - + : 50183664 : assert(sim[idx][i] == real[idx][i]);
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + ]
49 [ - + - + : 50183664 : assert(match == real[idx][i]);
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + ]
50 [ + + + + : 50183664 : assert((it == real[idx].end()) != (it != real[idx].end()));
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + ]
51 [ + + + + : 50183664 : if (match) {
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + ]
52 : 10144714 : ++it;
53 [ + + + + : 10144714 : if (first == S::Size()) first = i;
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + ]
54 : : last = i;
55 : : }
56 : : }
57 [ - + - + : 571080 : assert(it == real[idx].end());
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + ]
58 [ - + - + : 571080 : assert(!(it != real[idx].end()));
- + ]
59 : : /* Any / None */
60 [ - + - + : 1230028 : assert(sim[idx].any() == real[idx].Any());
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + ]
61 [ - + - + : 1018213 : assert(sim[idx].none() == real[idx].None());
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + ]
62 : : /* First / Last */
63 [ + + + + : 571080 : if (sim[idx].any()) {
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + ]
64 [ - + - + : 461005 : assert(first == real[idx].First());
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + ]
65 [ - + - + : 461005 : assert(last == real[idx].Last());
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + ]
66 : : }
67 : : /* Count */
68 [ - + - + : 782895 : assert(sim[idx].count() == real[idx].Count());
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + ]
69 : : };
70 : :
71 [ + + + + ]: 1154424 : LIMITED_WHILE(buffer.size() > 0, 1000) {
72 : : // Read one byte to determine which operation to execute on the BitSets.
73 : 1150836 : int command = ReadByte(buffer) % 64;
74 : : // Read another byte that determines which bitsets will be involved.
75 : 1150836 : unsigned args = ReadByte(buffer);
76 [ - + ]: 1150836 : unsigned dest = ((args & 7) * sim.size()) >> 3;
77 : 1150836 : unsigned src = (((args >> 3) & 7) * sim.size()) >> 3;
78 : 1150836 : unsigned aux = (((args >> 6) & 3) * sim.size()) >> 2;
79 : : // Args are in range for non-empty sim, or sim is completely empty and will be grown
80 [ + + - + : 1150836 : assert((sim.empty() && dest == 0 && src == 0 && aux == 0) ||
+ - + - +
- - + ]
81 : : (!sim.empty() && dest < sim.size() && src < sim.size() && aux < sim.size()));
82 : :
83 : : // Pick one operation based on value of command. Not all operations are always applicable.
84 : : // Loop through the applicable ones until command reaches 0 (which avoids the need to
85 : : // compute the number of applicable commands ahead of time).
86 : : while (true) {
87 [ + + + + ]: 2755169 : if (dest < sim.size() && command-- == 0) {
88 : : /* Set() (true) */
89 : 114648 : unsigned val = ReadByte(buffer) % S::Size();
90 [ - + ]: 114648 : assert(sim[dest][val] == real[dest][val]);
91 [ + - ]: 114648 : sim[dest].set(val);
92 : 114648 : real[dest].Set(val);
93 : 114648 : break;
94 [ + + + + ]: 2640521 : } else if (dest < sim.size() && command-- == 0) {
95 : : /* Reset() */
96 : 38277 : unsigned val = ReadByte(buffer) % S::Size();
97 [ - + ]: 38277 : assert(sim[dest][val] == real[dest][val]);
98 [ + - ]: 38277 : sim[dest].reset(val);
99 : 38277 : real[dest].Reset(val);
100 : 38277 : break;
101 [ + + + + ]: 2602244 : } else if (dest < sim.size() && command-- == 0) {
102 : : /* Set() (conditional) */
103 : 33153 : unsigned val = ReadByte(buffer) % S::Size();
104 [ - + ]: 33153 : assert(sim[dest][val] == real[dest][val]);
105 [ + - ]: 33153 : sim[dest].set(val, args >> 7);
106 : 33153 : real[dest].Set(val, args >> 7);
107 : 33153 : break;
108 [ + + + + ]: 2569091 : } else if (sim.size() < 4 && command-- == 0) {
109 : : /* Construct empty. */
110 [ + - ]: 15786 : sim.resize(sim.size() + 1);
111 [ + - ]: 15786 : real.resize(real.size() + 1);
112 : : break;
113 [ + + + + ]: 2553305 : } else if (sim.size() < 4 && command-- == 0) {
114 : : /* Construct singleton. */
115 : 17121 : unsigned val = ReadByte(buffer) % S::Size();
116 [ + + ]: 21058 : std::bitset<S::Size()> newset;
117 [ + - ]: 17121 : newset[val] = true;
118 [ + - ]: 17121 : sim.push_back(newset);
119 [ + - ]: 17121 : real.push_back(S::Singleton(val));
120 : : break;
121 [ + + + + ]: 2536184 : } else if (dest < sim.size() && command-- == 0) {
122 : : /* Make random. */
123 : 69080 : compare_fn(dest);
124 : 69080 : sim[dest].reset();
125 : 69080 : real[dest] = S{};
126 [ + + ]: 6087096 : for (unsigned i = 0; i < S::Size(); ++i) {
127 [ + + ]: 6018016 : if (rng.randbool()) {
128 : 3008338 : sim[dest][i] = true;
129 : 3008338 : real[dest].Set(i);
130 : : }
131 : : }
132 : : break;
133 [ + + + + ]: 2467104 : } else if (dest < sim.size() && command-- == 0) {
134 : : /* Assign initializer list. */
135 : 86829 : unsigned r1 = rng.randrange(S::Size());
136 : 86829 : unsigned r2 = rng.randrange(S::Size());
137 : 86829 : unsigned r3 = rng.randrange(S::Size());
138 : 86829 : compare_fn(dest);
139 : 86829 : sim[dest].reset();
140 : 86829 : real[dest] = {r1, r2, r3};
141 [ + - ]: 86829 : sim[dest].set(r1);
142 [ + - ]: 86829 : sim[dest].set(r2);
143 [ + - ]: 86829 : sim[dest].set(r3);
144 : : break;
145 [ + + + + ]: 2380275 : } else if (!sim.empty() && command-- == 0) {
146 : : /* Destruct. */
147 : 81550 : compare_fn(sim.size() - 1);
148 : 81550 : sim.pop_back();
149 : 81550 : real.pop_back();
150 : : break;
151 [ + + + + : 2298725 : } else if (sim.size() < 4 && src < sim.size() && command-- == 0) {
+ + ]
152 : : /* Copy construct. */
153 [ + - ]: 13441 : sim.emplace_back(sim[src]);
154 [ + - ]: 13441 : real.emplace_back(real[src]);
155 : : break;
156 [ + + + - : 2285284 : } else if (src < sim.size() && dest < sim.size() && command-- == 0) {
+ + ]
157 : : /* Copy assign. */
158 : 32108 : compare_fn(dest);
159 : 32108 : sim[dest] = sim[src];
160 : 32108 : real[dest] = real[src];
161 : 32108 : break;
162 [ + + + - : 2253176 : } else if (src < sim.size() && dest < sim.size() && command-- == 0) {
+ + ]
163 : : /* swap() function. */
164 : 28687 : swap(sim[dest], sim[src]);
165 : 941794 : swap(real[dest], real[src]);
166 : : break;
167 [ + + + + ]: 2224489 : } else if (sim.size() < 4 && command-- == 0) {
168 : : /* Construct with initializer list. */
169 : 38246 : unsigned r1 = rng.randrange(S::Size());
170 : 38246 : unsigned r2 = rng.randrange(S::Size());
171 [ + - ]: 38246 : sim.emplace_back();
172 [ + - ]: 38246 : sim.back().set(r1);
173 [ + - ]: 38246 : sim.back().set(r2);
174 [ + - ]: 267416 : real.push_back(S{r1, r2});
175 : : break;
176 [ + + + + ]: 2186243 : } else if (dest < sim.size() && command-- == 0) {
177 : : /* Fill() + copy assign. */
178 : 80276 : unsigned len = ReadByte(buffer) % S::Size();
179 : 80276 : compare_fn(dest);
180 : 80276 : sim[dest].reset();
181 [ + + ]: 2450648 : for (unsigned i = 0; i < len; ++i) sim[dest][i] = true;
182 : 80276 : real[dest] = S::Fill(len);
183 : 80276 : break;
184 [ + + + + ]: 2105967 : } else if (src < sim.size() && command-- == 0) {
185 : : /* Iterator copy based compare. */
186 : 102103 : unsigned val = ReadByte(buffer) % S::Size();
187 : : /* In a first loop, compare begin..end, and copy to it_copy at some point. */
188 [ + + ]: 102103 : auto it = real[src].begin(), it_copy = it;
189 [ + + ]: 8968503 : for (unsigned i = 0; i < S::Size(); ++i) {
190 [ + + ]: 8866400 : if (i == val) it_copy = it;
191 [ + + + + ]: 8866400 : bool match = (it != real[src].end()) && *it == i;
192 [ - + ]: 8866400 : assert(match == sim[src][i]);
193 [ + + ]: 8866400 : if (match) ++it;
194 : : }
195 [ - + ]: 102103 : assert(it == real[src].end());
196 : : /* Then compare from the copied point again to end. */
197 [ + + ]: 3748277 : for (unsigned i = val; i < S::Size(); ++i) {
198 [ + + + + ]: 3646174 : bool match = (it_copy != real[src].end()) && *it_copy == i;
199 [ - + ]: 3646174 : assert(match == sim[src][i]);
200 [ + + ]: 3646174 : if (match) ++it_copy;
201 : : }
202 [ - + ]: 102103 : assert(it_copy == real[src].end());
203 : : break;
204 [ + + + - : 2003864 : } else if (src < sim.size() && dest < sim.size() && command-- == 0) {
+ + ]
205 : : /* operator|= */
206 : 31292 : compare_fn(dest);
207 : 31292 : sim[dest] |= sim[src];
208 : 31292 : real[dest] |= real[src];
209 : : break;
210 [ + + + - : 1972572 : } else if (src < sim.size() && dest < sim.size() && command-- == 0) {
+ + ]
211 : : /* operator&= */
212 : 29078 : compare_fn(dest);
213 : 29078 : sim[dest] &= sim[src];
214 : 29078 : real[dest] &= real[src];
215 : : break;
216 [ + + + - : 1943494 : } else if (src < sim.size() && dest < sim.size() && command-- == 0) {
+ + ]
217 : : /* operator-= */
218 : 27863 : compare_fn(dest);
219 : 27863 : sim[dest] &= ~sim[src];
220 : 27863 : real[dest] -= real[src];
221 : 22268 : break;
222 [ + + + - : 1915631 : } else if (src < sim.size() && dest < sim.size() && command-- == 0) {
+ + ]
223 : : /* operator^= */
224 : 22467 : compare_fn(dest);
225 : 22467 : sim[dest] ^= sim[src];
226 : 935574 : real[dest] ^= real[src];
227 : : break;
228 [ + + + - : 1893164 : } else if (src < sim.size() && dest < sim.size() && aux < sim.size() && command-- == 0) {
+ - + + ]
229 : : /* operator| */
230 : 24796 : compare_fn(dest);
231 : 29151 : sim[dest] = sim[src] | sim[aux];
232 : 29151 : real[dest] = real[src] | real[aux];
233 : 24796 : break;
234 [ + + + - : 1868368 : } else if (src < sim.size() && dest < sim.size() && aux < sim.size() && command-- == 0) {
+ - + + ]
235 : : /* operator& */
236 : 27661 : compare_fn(dest);
237 : 32847 : sim[dest] = sim[src] & sim[aux];
238 : 32847 : real[dest] = real[src] & real[aux];
239 : 27661 : break;
240 [ + + + - : 1840707 : } else if (src < sim.size() && dest < sim.size() && aux < sim.size() && command-- == 0) {
+ - + + ]
241 : : /* operator- */
242 : 26205 : compare_fn(dest);
243 : 30766 : sim[dest] = sim[src] & ~sim[aux];
244 : 26205 : real[dest] = real[src] - real[aux];
245 : 26205 : break;
246 [ + + + - : 1814502 : } else if (src < sim.size() && dest < sim.size() && aux < sim.size() && command-- == 0) {
+ - + + ]
247 : : /* operator^ */
248 : 21655 : compare_fn(dest);
249 : 25260 : sim[dest] = sim[src] ^ sim[aux];
250 : 25260 : real[dest] = real[src] ^ real[aux];
251 : 21655 : break;
252 [ + + + - : 1792847 : } else if (src < sim.size() && aux < sim.size() && command-- == 0) {
+ + ]
253 : : /* IsSupersetOf() and IsSubsetOf() */
254 [ + + ]: 131856 : bool is_superset = (sim[aux] & ~sim[src]).none();
255 [ + + ]: 132339 : bool is_subset = (sim[src] & ~sim[aux]).none();
256 [ - + ]: 166630 : assert(real[src].IsSupersetOf(real[aux]) == is_superset);
257 [ - + ]: 91609 : assert(real[src].IsSubsetOf(real[aux]) == is_subset);
258 [ - + ]: 75021 : assert(real[aux].IsSupersetOf(real[src]) == is_subset);
259 [ - + ]: 75021 : assert(real[aux].IsSubsetOf(real[src]) == is_superset);
260 : : break;
261 [ + + + - : 1701238 : } else if (src < sim.size() && aux < sim.size() && command-- == 0) {
+ + ]
262 : : /* operator== and operator!= */
263 [ + + - + ]: 41388 : assert((sim[src] == sim[aux]) == (real[src] == real[aux]));
264 [ - + ]: 38685 : assert((sim[src] != sim[aux]) == (real[src] != real[aux]));
265 : : break;
266 [ + + + - : 2776924 : } else if (src < sim.size() && aux < sim.size() && command-- == 0) {
+ + + + ]
267 : : /* Overlaps() */
268 [ + + - + ]: 162595 : assert((sim[src] & sim[aux]).any() == real[src].Overlaps(real[aux]));
269 [ + + - + ]: 162595 : assert((sim[src] & sim[aux]).any() == real[aux].Overlaps(real[src]));
270 : : break;
271 : : }
272 : : }
273 : : }
274 : : /* Fully compare the final state. */
275 [ - + + + ]: 13808 : for (unsigned i = 0; i < sim.size(); ++i) {
276 : 10220 : compare_fn(i);
277 : : }
278 : 3588 : }
279 : :
280 : : } // namespace
281 : :
282 [ + - ]: 2498 : FUZZ_TARGET(bitset)
283 : : {
284 : 2042 : unsigned typdat = ReadByte(buffer) % 8;
285 [ + + ]: 2042 : if (typdat == 0) {
286 : : /* 16 bits */
287 : 223 : TestType<bitset_detail::IntBitSet<uint16_t>>(buffer);
288 : 223 : TestType<bitset_detail::MultiIntBitSet<uint16_t, 1>>(buffer);
289 [ + + ]: 1819 : } else if (typdat == 1) {
290 : : /* 32 bits */
291 : 244 : TestType<bitset_detail::MultiIntBitSet<uint16_t, 2>>(buffer);
292 : 244 : TestType<bitset_detail::IntBitSet<uint32_t>>(buffer);
293 [ + + ]: 1575 : } else if (typdat == 2) {
294 : : /* 48 bits */
295 : 249 : TestType<bitset_detail::MultiIntBitSet<uint16_t, 3>>(buffer);
296 [ + + ]: 1326 : } else if (typdat == 3) {
297 : : /* 64 bits */
298 : 267 : TestType<bitset_detail::IntBitSet<uint64_t>>(buffer);
299 : 267 : TestType<bitset_detail::MultiIntBitSet<uint64_t, 1>>(buffer);
300 : 267 : TestType<bitset_detail::MultiIntBitSet<uint32_t, 2>>(buffer);
301 : 267 : TestType<bitset_detail::MultiIntBitSet<uint16_t, 4>>(buffer);
302 [ + + ]: 1059 : } else if (typdat == 4) {
303 : : /* 96 bits */
304 : 247 : TestType<bitset_detail::MultiIntBitSet<uint32_t, 3>>(buffer);
305 [ + + ]: 812 : } else if (typdat == 5) {
306 : : /* 128 bits */
307 : 278 : TestType<bitset_detail::MultiIntBitSet<uint64_t, 2>>(buffer);
308 : 278 : TestType<bitset_detail::MultiIntBitSet<uint32_t, 4>>(buffer);
309 [ + + ]: 534 : } else if (typdat == 6) {
310 : : /* 192 bits */
311 : 266 : TestType<bitset_detail::MultiIntBitSet<uint64_t, 3>>(buffer);
312 [ + - ]: 268 : } else if (typdat == 7) {
313 : : /* 256 bits */
314 : 268 : TestType<bitset_detail::MultiIntBitSet<uint64_t, 4>>(buffer);
315 : : }
316 : 2042 : }
|
