Bitcoin Core  29.1.0
P2P Digital Currency
golomb_rice.cpp
Go to the documentation of this file.
1 // Copyright (c) 2020-2022 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 <blockfilter.h>
6 #include <serialize.h>
7 #include <streams.h>
9 #include <test/fuzz/fuzz.h>
10 #include <test/fuzz/util.h>
11 #include <test/util/random.h>
12 #include <util/bytevectorhash.h>
13 #include <util/golombrice.h>
14 
15 #include <algorithm>
16 #include <cassert>
17 #include <cstdint>
18 #include <iosfwd>
19 #include <unordered_set>
20 #include <vector>
21 
22 namespace {
23 
24 uint64_t HashToRange(const std::vector<uint8_t>& element, const uint64_t f)
25 {
26  const uint64_t hash = CSipHasher(0x0706050403020100ULL, 0x0F0E0D0C0B0A0908ULL)
27  .Write(element)
28  .Finalize();
29  return FastRange64(hash, f);
30 }
31 
32 std::vector<uint64_t> BuildHashedSet(const std::unordered_set<std::vector<uint8_t>, ByteVectorHash>& elements, const uint64_t f)
33 {
34  std::vector<uint64_t> hashed_elements;
35  hashed_elements.reserve(elements.size());
36  for (const std::vector<uint8_t>& element : elements) {
37  hashed_elements.push_back(HashToRange(element, f));
38  }
39  std::sort(hashed_elements.begin(), hashed_elements.end());
40  return hashed_elements;
41 }
42 } // namespace
43 
44 FUZZ_TARGET(golomb_rice)
45 {
47  FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
48  std::vector<uint8_t> golomb_rice_data;
49  std::vector<uint64_t> encoded_deltas;
50  {
51  std::unordered_set<std::vector<uint8_t>, ByteVectorHash> elements;
52  const int n = fuzzed_data_provider.ConsumeIntegralInRange<int>(0, 512);
53  for (int i = 0; i < n; ++i) {
54  elements.insert(ConsumeRandomLengthByteVector(fuzzed_data_provider, 16));
55  }
56  VectorWriter stream{golomb_rice_data, 0};
57  WriteCompactSize(stream, static_cast<uint32_t>(elements.size()));
58  BitStreamWriter bitwriter{stream};
59  if (!elements.empty()) {
60  uint64_t last_value = 0;
61  for (const uint64_t value : BuildHashedSet(elements, static_cast<uint64_t>(elements.size()) * static_cast<uint64_t>(BASIC_FILTER_M))) {
62  const uint64_t delta = value - last_value;
63  encoded_deltas.push_back(delta);
64  GolombRiceEncode(bitwriter, BASIC_FILTER_P, delta);
65  last_value = value;
66  }
67  }
68  bitwriter.Flush();
69  }
70 
71  std::vector<uint64_t> decoded_deltas;
72  {
73  SpanReader stream{golomb_rice_data};
74  BitStreamReader bitreader{stream};
75  const uint32_t n = static_cast<uint32_t>(ReadCompactSize(stream));
76  for (uint32_t i = 0; i < n; ++i) {
77  decoded_deltas.push_back(GolombRiceDecode(bitreader, BASIC_FILTER_P));
78  }
79  }
80 
81  assert(encoded_deltas == decoded_deltas);
82 
83  {
84  const std::vector<uint8_t> random_bytes = ConsumeRandomLengthByteVector(fuzzed_data_provider, 1024);
85  SpanReader stream{random_bytes};
86  uint32_t n;
87  try {
88  n = static_cast<uint32_t>(ReadCompactSize(stream));
89  } catch (const std::ios_base::failure&) {
90  return;
91  }
92  BitStreamReader bitreader{stream};
93  for (uint32_t i = 0; i < std::min<uint32_t>(n, 1024); ++i) {
94  try {
95  (void)GolombRiceDecode(bitreader, BASIC_FILTER_P);
96  } catch (const std::ios_base::failure&) {
97  }
98  }
99  }
100 }
assert(!tx.IsCoinBase())
constexpr uint32_t BASIC_FILTER_M
Definition: blockfilter.h:90
CSipHasher & Write(uint64_t data)
Hash a 64-bit integer worth of data It is treated as if this was the little-endian interpretation of ...
Definition: siphash.cpp:28
uint64_t ReadCompactSize(Stream &is, bool range_check=true)
Decode a CompactSize-encoded variable-length integer.
Definition: serialize.h:339
static uint64_t FastRange64(uint64_t x, uint64_t n)
Fast range reduction with 64-bit input and 64-bit range.
Definition: fastrange.h:25
constexpr uint8_t BASIC_FILTER_P
Definition: blockfilter.h:89
std::vector< B > ConsumeRandomLengthByteVector(FuzzedDataProvider &fuzzed_data_provider, const std::optional< size_t > &max_length=std::nullopt) noexcept
Definition: util.h:57
Minimal stream for reading from an existing byte array by Span.
Definition: streams.h:100
uint64_t GolombRiceDecode(BitStreamReader< IStream > &bitreader, uint8_t P)
Definition: golombrice.h:32
void WriteCompactSize(SizeComputer &os, uint64_t nSize)
Definition: serialize.h:1097
FUZZ_TARGET(golomb_rice)
Definition: golomb_rice.cpp:44
Implementation of Hash named requirement for types that internally store a byte array.
uint64_t Finalize() const
Compute the 64-bit SipHash-2-4 of the data written so far.
Definition: siphash.cpp:77
void SeedRandomStateForTest(SeedRand seedtype)
Seed the global RNG state for testing and log the seed value.
Definition: random.cpp:19
void GolombRiceEncode(BitStreamWriter< OStream > &bitwriter, uint8_t P, uint64_t x)
Definition: golombrice.h:15
SipHash-2-4.
Definition: siphash.h:14
Seed with a compile time constant of zeros.