Branch data Line data Source code
1 : : // Copyright (c) 2018-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 <mutex>
6 : : #include <set>
7 : :
8 : : #include <blockfilter.h>
9 : : #include <crypto/siphash.h>
10 : : #include <hash.h>
11 : : #include <primitives/block.h>
12 : : #include <primitives/transaction.h>
13 : : #include <script/script.h>
14 : : #include <streams.h>
15 : : #include <undo.h>
16 : : #include <util/golombrice.h>
17 : : #include <util/string.h>
18 : :
19 : : using util::Join;
20 : :
21 : : static const std::map<BlockFilterType, std::string> g_filter_types = {
22 : : {BlockFilterType::BASIC, "basic"},
23 : : };
24 : :
25 : 145382 : uint64_t GCSFilter::HashToRange(const Element& element) const
26 : : {
27 : 145382 : uint64_t hash = CSipHasher(m_params.m_siphash_k0, m_params.m_siphash_k1)
28 : 145382 : .Write(element)
29 : 145382 : .Finalize();
30 : 145382 : return FastRange64(hash, m_F);
31 : : }
32 : :
33 : 260 : std::vector<uint64_t> GCSFilter::BuildHashedSet(const ElementSet& elements) const
34 : : {
35 : 260 : std::vector<uint64_t> hashed_elements;
36 [ + - ]: 260 : hashed_elements.reserve(elements.size());
37 [ + + ]: 145382 : for (const Element& element : elements) {
38 [ + - + - ]: 145122 : hashed_elements.push_back(HashToRange(element));
39 : : }
40 : 260 : std::sort(hashed_elements.begin(), hashed_elements.end());
41 : 260 : return hashed_elements;
42 : 0 : }
43 : :
44 : 392 : GCSFilter::GCSFilter(const Params& params)
45 : 392 : : m_params(params), m_N(0), m_F(0), m_encoded{0}
46 : 392 : {}
47 : :
48 : 359 : GCSFilter::GCSFilter(const Params& params, std::vector<unsigned char> encoded_filter, bool skip_decode_check)
49 [ + + ]: 359 : : m_params(params), m_encoded(std::move(encoded_filter))
50 : : {
51 [ + + ]: 359 : SpanReader stream{m_encoded};
52 : :
53 [ + + ]: 359 : uint64_t N = ReadCompactSize(stream);
54 : 340 : m_N = static_cast<uint32_t>(N);
55 [ - + ]: 340 : if (m_N != N) {
56 [ # # ]: 0 : throw std::ios_base::failure("N must be <2^32");
57 : : }
58 : 340 : m_F = static_cast<uint64_t>(m_N) * static_cast<uint64_t>(m_params.m_M);
59 : :
60 [ + - ]: 340 : if (skip_decode_check) return;
61 : :
62 : : // Verify that the encoded filter contains exactly N elements. If it has too much or too little
63 : : // data, a std::ios_base::failure exception will be raised.
64 : 340 : BitStreamReader bitreader{stream};
65 [ + + ]: 79809 : for (uint64_t i = 0; i < m_N; ++i) {
66 [ + + ]: 79502 : GolombRiceDecode(bitreader, m_params.m_P);
67 : : }
68 [ + + ]: 307 : if (!stream.empty()) {
69 [ + - ]: 6 : throw std::ios_base::failure("encoded_filter contains excess data");
70 : : }
71 : 58 : }
72 : :
73 : 0 : GCSFilter::GCSFilter(const Params& params, const ElementSet& elements)
74 [ # # ]: 0 : : m_params(params)
75 : : {
76 [ # # ]: 0 : size_t N = elements.size();
77 : 0 : m_N = static_cast<uint32_t>(N);
78 [ # # ]: 0 : if (m_N != N) {
79 [ # # ]: 0 : throw std::invalid_argument("N must be <2^32");
80 : : }
81 : 0 : m_F = static_cast<uint64_t>(m_N) * static_cast<uint64_t>(m_params.m_M);
82 : :
83 [ # # ]: 0 : VectorWriter stream{m_encoded, 0};
84 : :
85 [ # # ]: 0 : WriteCompactSize(stream, m_N);
86 : :
87 [ # # ]: 0 : if (elements.empty()) {
88 : : return;
89 : : }
90 : :
91 [ # # ]: 0 : BitStreamWriter bitwriter{stream};
92 : :
93 : 0 : uint64_t last_value = 0;
94 [ # # # # ]: 0 : for (uint64_t value : BuildHashedSet(elements)) {
95 : 0 : uint64_t delta = value - last_value;
96 [ # # ]: 0 : GolombRiceEncode(bitwriter, m_params.m_P, delta);
97 : 0 : last_value = value;
98 : 0 : }
99 : :
100 [ # # ]: 0 : bitwriter.Flush();
101 : 0 : }
102 : :
103 : 520 : bool GCSFilter::MatchInternal(const uint64_t* element_hashes, size_t size) const
104 : : {
105 : 520 : SpanReader stream{m_encoded};
106 : :
107 : : // Seek forward by size of N
108 : 520 : uint64_t N = ReadCompactSize(stream);
109 [ - + ]: 520 : assert(N == m_N);
110 : :
111 : 520 : BitStreamReader bitreader{stream};
112 : :
113 : 520 : uint64_t value = 0;
114 : 520 : size_t hashes_index = 0;
115 [ + + ]: 108144 : for (uint32_t i = 0; i < m_N; ++i) {
116 : 107960 : uint64_t delta = GolombRiceDecode(bitreader, m_params.m_P);
117 : 107960 : value += delta;
118 : :
119 : 372734 : while (true) {
120 [ + + ]: 240347 : if (hashes_index == size) {
121 : : return false;
122 [ + + ]: 240016 : } else if (element_hashes[hashes_index] == value) {
123 : : return true;
124 [ + + ]: 240011 : } else if (element_hashes[hashes_index] > value) {
125 : : break;
126 : : }
127 : :
128 : 132387 : hashes_index++;
129 : : }
130 : : }
131 : :
132 : : return false;
133 : : }
134 : :
135 : 260 : bool GCSFilter::Match(const Element& element) const
136 : : {
137 : 260 : uint64_t query = HashToRange(element);
138 : 260 : return MatchInternal(&query, 1);
139 : : }
140 : :
141 : 260 : bool GCSFilter::MatchAny(const ElementSet& elements) const
142 : : {
143 : 260 : const std::vector<uint64_t> queries = BuildHashedSet(elements);
144 [ + - ]: 260 : return MatchInternal(queries.data(), queries.size());
145 : 260 : }
146 : :
147 : 397 : const std::string& BlockFilterTypeName(BlockFilterType filter_type)
148 : : {
149 [ + + + - ]: 481 : static std::string unknown_retval;
150 : 397 : auto it = g_filter_types.find(filter_type);
151 [ + - ]: 397 : return it != g_filter_types.end() ? it->second : unknown_retval;
152 : : }
153 : :
154 : 824 : bool BlockFilterTypeByName(const std::string& name, BlockFilterType& filter_type) {
155 [ + + ]: 1645 : for (const auto& entry : g_filter_types) {
156 [ + + ]: 824 : if (entry.second == name) {
157 : 3 : filter_type = entry.first;
158 : 3 : return true;
159 : : }
160 : : }
161 : : return false;
162 : : }
163 : :
164 : 0 : const std::set<BlockFilterType>& AllBlockFilterTypes()
165 : : {
166 [ # # # # ]: 0 : static std::set<BlockFilterType> types;
167 : :
168 : 0 : static std::once_flag flag;
169 : 0 : std::call_once(flag, []() {
170 [ # # ]: 0 : for (const auto& entry : g_filter_types) {
171 : 0 : types.insert(entry.first);
172 : : }
173 : 0 : });
174 : :
175 : 0 : return types;
176 : : }
177 : :
178 : 1232 : const std::string& ListBlockFilterTypes()
179 : : {
180 [ + + + - : 1400 : static std::string type_list{Join(g_filter_types, ", ", [](const auto& entry) { return entry.second; })};
+ - + - ]
181 : :
182 : 1232 : return type_list;
183 : : }
184 : :
185 : 0 : static GCSFilter::ElementSet BasicFilterElements(const CBlock& block,
186 : : const CBlockUndo& block_undo)
187 : : {
188 : 0 : GCSFilter::ElementSet elements;
189 : :
190 [ # # ]: 0 : for (const CTransactionRef& tx : block.vtx) {
191 [ # # ]: 0 : for (const CTxOut& txout : tx->vout) {
192 : 0 : const CScript& script = txout.scriptPubKey;
193 [ # # # # : 0 : if (script.empty() || script[0] == OP_RETURN) continue;
# # # # ]
194 [ # # ]: 0 : elements.emplace(script.begin(), script.end());
195 : : }
196 : : }
197 : :
198 [ # # ]: 0 : for (const CTxUndo& tx_undo : block_undo.vtxundo) {
199 [ # # ]: 0 : for (const Coin& prevout : tx_undo.vprevout) {
200 : 0 : const CScript& script = prevout.out.scriptPubKey;
201 [ # # # # ]: 0 : if (script.empty()) continue;
202 [ # # # # ]: 0 : elements.emplace(script.begin(), script.end());
203 : : }
204 : : }
205 : :
206 : 0 : return elements;
207 : 0 : }
208 : :
209 : 0 : BlockFilter::BlockFilter(BlockFilterType filter_type, const uint256& block_hash,
210 : 0 : std::vector<unsigned char> filter, bool skip_decode_check)
211 : 0 : : m_filter_type(filter_type), m_block_hash(block_hash)
212 : : {
213 [ # # ]: 0 : GCSFilter::Params params;
214 [ # # # # ]: 0 : if (!BuildParams(params)) {
215 [ # # ]: 0 : throw std::invalid_argument("unknown filter_type");
216 : : }
217 [ # # ]: 0 : m_filter = GCSFilter(params, std::move(filter), skip_decode_check);
218 : 0 : }
219 : :
220 : 0 : BlockFilter::BlockFilter(BlockFilterType filter_type, const CBlock& block, const CBlockUndo& block_undo)
221 : 0 : : m_filter_type(filter_type), m_block_hash(block.GetHash())
222 : : {
223 [ # # ]: 0 : GCSFilter::Params params;
224 [ # # # # ]: 0 : if (!BuildParams(params)) {
225 [ # # ]: 0 : throw std::invalid_argument("unknown filter_type");
226 : : }
227 [ # # # # ]: 0 : m_filter = GCSFilter(params, BasicFilterElements(block, block_undo));
228 : 0 : }
229 : :
230 : 363 : bool BlockFilter::BuildParams(GCSFilter::Params& params) const
231 : : {
232 [ + + ]: 363 : switch (m_filter_type) {
233 : 359 : case BlockFilterType::BASIC:
234 : 359 : params.m_siphash_k0 = m_block_hash.GetUint64(0);
235 : 359 : params.m_siphash_k1 = m_block_hash.GetUint64(1);
236 : 359 : params.m_P = BASIC_FILTER_P;
237 : 359 : params.m_M = BASIC_FILTER_M;
238 : 359 : return true;
239 : : case BlockFilterType::INVALID:
240 : : return false;
241 : : }
242 : :
243 : : return false;
244 : : }
245 : :
246 : 520 : uint256 BlockFilter::GetHash() const
247 : : {
248 : 520 : return Hash(GetEncodedFilter());
249 : : }
250 : :
251 : 260 : uint256 BlockFilter::ComputeHeader(const uint256& prev_header) const
252 : : {
253 : 260 : return Hash(GetHash(), prev_header);
254 : : }
|
