Electroneum
db_lmdb.h
Go to the documentation of this file.
1 // Copyrights(c) 2017-2021, The Electroneum Project
2 // Copyrights(c) 2014-2019, The Monero Project
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without modification, are
6 // permitted provided that the following conditions are met:
7 //
8 // 1. Redistributions of source code must retain the above copyright notice, this list of
9 // conditions and the following disclaimer.
10 //
11 // 2. Redistributions in binary form must reproduce the above copyright notice, this list
12 // of conditions and the following disclaimer in the documentation and/or other
13 // materials provided with the distribution.
14 //
15 // 3. Neither the name of the copyright holder nor the names of its contributors may be
16 // used to endorse or promote products derived from this software without specific
17 // prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
20 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
22 // THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
27 // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #pragma once
29 
30 #include <atomic>
31 
33 #include "cryptonote_basic/blobdatatype.h" // for type blobdata
34 #include "ringct/rctTypes.h"
35 #include <boost/thread/tss.hpp>
36 
37 #include <lmdb.h>
38 
39 #define ENABLE_AUTO_RESIZE
40 
41 namespace cryptonote
42 {
43 
44 typedef struct txindex {
47 } txindex;
48 
49 typedef struct mdb_txn_cursors
50 {
54 
57 
65 
67 
70 
72 
80 
81 #define m_cur_blocks m_cursors->m_txc_blocks
82 #define m_cur_block_heights m_cursors->m_txc_block_heights
83 #define m_cur_block_info m_cursors->m_txc_block_info
84 #define m_cur_output_txs m_cursors->m_txc_output_txs
85 #define m_cur_output_amounts m_cursors->m_txc_output_amounts
86 #define m_cur_txs m_cursors->m_txc_txs
87 #define m_cur_txs_pruned m_cursors->m_txc_txs_pruned
88 #define m_cur_txs_prunable m_cursors->m_txc_txs_prunable
89 #define m_cur_txs_prunable_hash m_cursors->m_txc_txs_prunable_hash
90 #define m_cur_txs_prunable_tip m_cursors->m_txc_txs_prunable_tip
91 #define m_cur_tx_indices m_cursors->m_txc_tx_indices
92 #define m_cur_tx_outputs m_cursors->m_txc_tx_outputs
93 #define m_cur_spent_keys m_cursors->m_txc_spent_keys
94 #define m_cur_txpool_meta m_cursors->m_txc_txpool_meta
95 #define m_cur_txpool_blob m_cursors->m_txc_txpool_blob
96 #define m_cur_hf_versions m_cursors->m_txc_hf_versions
97 #define m_cur_properties m_cursors->m_txc_properties
98 #define m_cur_validators m_cursors->m_txc_validators
99 #define m_cur_utxos m_cursors->m_txc_utxos
100 #define m_cur_addr_outputs m_cursors->m_txc_addr_outputs
101 #define m_cur_addr_txs m_cursors->m_txc_addr_txs
102 #define m_cur_tx_inputs m_cursors->m_txc_tx_inputs
103 
104 typedef struct mdb_rflags
105 {
106  bool m_rf_txn;
112  bool m_rf_txs;
129 } mdb_rflags;
130 
131 typedef struct mdb_threadinfo
132 {
133  MDB_txn *m_ti_rtxn; // per-thread read txn
134  mdb_txn_cursors m_ti_rcursors; // per-thread read cursors
135  mdb_rflags m_ti_rflags; // per-thread read state
136 
137  ~mdb_threadinfo();
139 
141 {
142  mdb_txn_safe(const bool check=true);
143  ~mdb_txn_safe();
144 
145  void commit(std::string message = "");
146 
147  // This should only be needed for batch transaction which must be ensured to
148  // be aborted before mdb_env_close, not after. So we can't rely on
149  // BlockchainLMDB destructor to call mdb_txn_safe destructor, as that's too late
150  // to properly abort, since mdb_env_close would have been called earlier.
151  void abort();
152  void uncheck();
153 
154  operator MDB_txn*()
155  {
156  return m_txn;
157  }
158 
159  operator MDB_txn**()
160  {
161  return &m_txn;
162  }
163 
164  uint64_t num_active_tx() const;
165 
166  static void prevent_new_txns();
167  static void wait_no_active_txns();
168  static void allow_new_txns();
169 
172  bool m_batch_txn = false;
173  bool m_check;
174  static std::atomic<uint64_t> num_active_txns;
175 
176  // could use a mutex here, but this should be sufficient.
177  static std::atomic_flag creation_gate;
178 };
179 
180 
181 // If m_batch_active is set, a batch transaction exists beyond this class, such
182 // as a batch import with verification enabled, or possibly (later) a batch
183 // network sync.
184 //
185 // For some of the lookup methods, such as get_block_timestamp(), tx_exists(),
186 // and get_tx(), when m_batch_active is set, the lookup uses the batch
187 // transaction. This isn't only because the transaction is available, but it's
188 // necessary so that lookups include the database updates only present in the
189 // current batch write.
190 //
191 // A regular network sync without batch writes is expected to open a new read
192 // transaction, as those lookups are part of the validation done prior to the
193 // write for block and tx data, so no write transaction is open at the time.
195 {
196 public:
197  BlockchainLMDB(bool batch_transactions=true);
198  ~BlockchainLMDB();
199 
200  virtual void open(const std::string& filename, const int mdb_flags=0);
201 
202  virtual void close();
203 
204  virtual void sync();
205 
206  virtual void safesyncmode(const bool onoff);
207 
208  virtual void reset();
209 
210  virtual std::vector<std::string> get_filenames() const;
211 
212  virtual bool remove_data_file(const std::string& folder) const;
213 
214  virtual std::string get_db_name() const;
215 
216  virtual bool lock();
217 
218  virtual void unlock();
219 
220  virtual bool block_exists(const crypto::hash& h, uint64_t *height = NULL) const;
221 
222  virtual uint64_t get_block_height(const crypto::hash& h) const;
223 
224  virtual block_header get_block_header(const crypto::hash& h) const;
225 
226  virtual cryptonote::blobdata get_block_blob(const crypto::hash& h) const;
227 
229 
230  virtual std::vector<uint64_t> get_block_cumulative_rct_outputs(const std::vector<uint64_t> &heights) const;
231 
232  virtual uint64_t get_block_timestamp(const uint64_t& height) const;
233 
234  virtual uint64_t get_top_block_timestamp() const;
235 
236  virtual size_t get_block_weight(const uint64_t& height) const;
237 
238  virtual std::vector<uint64_t> get_block_weights(uint64_t start_height, size_t count) const;
239 
241 
243 
244  virtual difficulty_type get_block_difficulty(const uint64_t& height) const;
245 
247 
248  virtual uint64_t get_block_long_term_weight(const uint64_t& height) const;
249 
250  virtual std::vector<uint64_t> get_long_term_block_weights(uint64_t start_height, size_t count) const;
251 
253 
254  virtual std::vector<block> get_blocks_range(const uint64_t& h1, const uint64_t& h2) const;
255 
256  virtual std::vector<crypto::hash> get_hashes_range(const uint64_t& h1, const uint64_t& h2) const;
257 
258  virtual crypto::hash top_block_hash(uint64_t *block_height = NULL) const;
259 
260  virtual block get_top_block() const;
261 
262  virtual uint64_t height() const;
263 
264  virtual bool tx_exists(const crypto::hash& h) const;
265  virtual bool tx_exists(const crypto::hash& h, uint64_t& tx_index) const;
266 
267  virtual uint64_t get_tx_unlock_time(const crypto::hash& h) const;
268 
269  virtual bool get_tx_blob(const crypto::hash& h, cryptonote::blobdata &tx) const;
270  virtual bool get_pruned_tx_blob(const crypto::hash& h, cryptonote::blobdata &tx) const;
271  virtual bool get_prunable_tx_blob(const crypto::hash& h, cryptonote::blobdata &tx) const;
272  virtual bool get_prunable_tx_hash(const crypto::hash& tx_hash, crypto::hash &prunable_hash) const;
273 
274  virtual uint64_t get_tx_count() const;
275 
276  virtual std::vector<transaction> get_tx_list(const std::vector<crypto::hash>& hlist) const;
277 
278  virtual uint64_t get_tx_block_height(const crypto::hash& h) const;
279 
280  virtual uint64_t get_num_outputs(const uint64_t& amount) const;
281 
282  virtual output_data_t get_output_key(const uint64_t& amount, const uint64_t& index, bool include_commitmemt) const;
283  virtual void get_output_key(const epee::span<const uint64_t> &amounts, const std::vector<uint64_t> &offsets, std::vector<output_data_t> &outputs, bool allow_partial = false) const;
284 
285  virtual tx_out_index get_output_tx_and_index_from_global(const uint64_t& index) const;
286  virtual void get_output_tx_and_index_from_global(const std::vector<uint64_t> &global_indices,
287  std::vector<tx_out_index> &tx_out_indices) const;
288 
289  virtual tx_out_index get_output_tx_and_index(const uint64_t& amount, const uint64_t& index) const;
290  virtual void get_output_tx_and_index(const uint64_t& amount, const std::vector<uint64_t> &offsets, std::vector<tx_out_index> &indices) const;
291 
292  virtual std::vector<std::vector<uint64_t>> get_tx_amount_output_indices(const uint64_t tx_id, size_t n_txes) const;
293 
294  virtual bool has_key_image(const crypto::key_image& img) const;
295 
296  virtual void add_txpool_tx(const crypto::hash &txid, const cryptonote::blobdata &blob, const txpool_tx_meta_t& meta);
297  virtual void update_txpool_tx(const crypto::hash &txid, const txpool_tx_meta_t& meta);
298  virtual uint64_t get_txpool_tx_count(bool include_unrelayed_txes = true) const;
299  virtual bool txpool_has_tx(const crypto::hash &txid) const;
300  virtual void remove_txpool_tx(const crypto::hash& txid);
301  virtual bool get_txpool_tx_meta(const crypto::hash& txid, txpool_tx_meta_t &meta) const;
302  virtual bool get_txpool_tx_blob(const crypto::hash& txid, cryptonote::blobdata &bd) const;
303  virtual cryptonote::blobdata get_txpool_tx_blob(const crypto::hash& txid) const;
304  virtual uint32_t get_blockchain_pruning_seed() const;
305  virtual bool prune_blockchain(uint32_t pruning_seed = 0);
306  virtual bool update_pruning();
307  virtual bool check_pruning();
308 
309  virtual bool for_all_txpool_txes(std::function<bool(const crypto::hash&, const txpool_tx_meta_t&, const cryptonote::blobdata*)> f, bool include_blob = false, bool include_unrelayed_txes = true) const;
310 
311  virtual bool for_all_key_images(std::function<bool(const crypto::key_image&)>) const;
312  virtual bool for_blocks_range(const uint64_t& h1, const uint64_t& h2, std::function<bool(uint64_t, const crypto::hash&, const cryptonote::block&)>) const;
313  virtual bool for_all_transactions(std::function<bool(const crypto::hash&, const cryptonote::transaction&)>, bool pruned) const;
314  virtual bool for_all_outputs(std::function<bool(uint64_t amount, const crypto::hash &tx_hash, uint64_t height, size_t tx_idx)> f) const;
315  virtual bool for_all_outputs(uint64_t amount, const std::function<bool(uint64_t height)> &f) const;
316 
317  virtual uint64_t add_block( const std::pair<block, blobdata>& blk
318  , size_t block_weight
319  , uint64_t long_term_block_weight
320  , const difficulty_type& cumulative_difficulty
321  , const uint64_t& coins_generated
322  , const std::vector<std::pair<transaction, blobdata>>& txs
323  );
324 
325  virtual void set_batch_transactions(bool batch_transactions);
326  virtual bool batch_start(uint64_t batch_num_blocks=0, uint64_t batch_bytes=0);
327  virtual void batch_commit();
328  virtual void batch_stop();
329  virtual void batch_abort();
330 
331  virtual void block_wtxn_start();
332  virtual void block_wtxn_stop();
333  virtual void block_wtxn_abort();
334  virtual bool block_rtxn_start() const;
335  virtual void block_rtxn_stop() const;
336  virtual void block_rtxn_abort() const;
337 
338  bool block_rtxn_start(MDB_txn **mtxn, mdb_txn_cursors **mcur) const;
339 
340  virtual void pop_block(block& blk, std::vector<transaction>& txs);
341 
342  virtual bool can_thread_bulk_indices() const { return true; }
343 
354  std::map<uint64_t, std::tuple<uint64_t, uint64_t, uint64_t>> get_output_histogram(const std::vector<uint64_t> &amounts, bool unlocked, uint64_t recent_cutoff, uint64_t min_count) const;
355 
356  bool get_output_distribution(uint64_t amount, uint64_t from_height, uint64_t to_height, std::vector<uint64_t> &distribution, uint64_t &base) const;
357 
358  virtual std::vector<address_outputs> get_addr_output_all(const crypto::public_key& combined_key);
359  virtual std::vector<address_outputs> get_addr_output_batch(const crypto::public_key& combined_key, uint64_t start_db_index = 0, uint64_t batch_size = 100, bool desc = false);
360  virtual std::vector<address_txs> get_addr_tx_all(const crypto::public_key& combined_key);
361  virtual std::vector<address_txs> get_addr_tx_batch(const crypto::public_key& combined_key, uint64_t start_db_index = 0, uint64_t batch_size = 100, bool desc = false);
362  virtual uint64_t get_balance(const crypto::public_key& combined_key);
363  virtual tx_input_t get_tx_input(const crypto::hash tx_hash, const uint32_t relative_out_index);
364 
365  // helper functions
366  static int compare_uint64(const MDB_val *a, const MDB_val *b);
367  static int compare_hash32(const MDB_val *a, const MDB_val *b);
368  static int compare_string(const MDB_val *a, const MDB_val *b);
369  static int compare_data(const MDB_val *a, const MDB_val *b);
370  static int compare_publickey(const MDB_val *a, const MDB_val *b);
371 
372 private:
373  void do_resize(uint64_t size_increase=0);
374 
375  bool need_resize(uint64_t threshold_size=0) const;
376  void check_and_resize_for_batch(uint64_t batch_num_blocks, uint64_t batch_bytes);
377  uint64_t get_estimated_batch_size(uint64_t batch_num_blocks, uint64_t batch_bytes) const;
378 
379  virtual void add_block( const block& blk
380  , size_t block_weight
381  , uint64_t long_term_block_weight
382  , const difficulty_type& cumulative_difficulty
383  , const uint64_t& coins_generated
384  , uint64_t num_rct_outs
385  , const crypto::hash& block_hash
386  );
387 
388  virtual void remove_block();
389 
390  virtual uint64_t add_transaction_data(const crypto::hash& blk_hash, const std::pair<transaction, blobdata>& tx, const crypto::hash& tx_hash, const crypto::hash& tx_prunable_hash);
391 
392  virtual void remove_transaction_data(const crypto::hash& tx_hash, const transaction& tx);
393 
394  virtual uint64_t add_output(const crypto::hash& tx_hash,
395  const tx_out& tx_output,
396  const uint64_t& local_index,
397  const uint64_t unlock_time,
398  const rct::key *commitment
399  );
400 
401  virtual void add_tx_amount_output_indices(const uint64_t tx_id,
402  const std::vector<uint64_t>& amount_output_indices
403  );
404 
405  void remove_tx_outputs(const uint64_t tx_id, const transaction& tx);
406 
407  void remove_output(const uint64_t amount, const uint64_t& out_index);
408 
409  virtual void prune_outputs(uint64_t amount);
410 
411  virtual void add_spent_key(const crypto::key_image& k_image);
412 
413  virtual void remove_spent_key(const crypto::key_image& k_image);
414 
415  uint64_t num_outputs() const;
416 
417  // Hard fork
418  virtual void set_hard_fork_version(uint64_t height, uint8_t version);
419  virtual uint8_t get_hard_fork_version(uint64_t height) const;
420  virtual void check_hard_fork_info();
421  virtual void drop_hard_fork_info();
422 
423  inline void check_open() const;
424 
425  bool prune_worker(int mode, uint32_t pruning_seed);
426 
427  virtual bool is_read_only() const;
428 
429  virtual uint64_t get_database_size() const;
430 
431  std::vector<uint64_t> get_block_info_64bit_fields(uint64_t start_height, size_t count, off_t offset) const;
432 
433  uint64_t get_max_block_size();
434  void add_max_block_size(uint64_t sz);
435 
436  // fix up anything that may be wrong due to past bugs
437  virtual void fixup();
438 
439  // Validator List
440  virtual void set_validator_list(std::string validators, uint32_t expiration_date);
441  virtual std::string get_validator_list() const;
442  blobdata validator_to_blob(const validator_db& v) const;
443  validator_db validator_from_blob(const blobdata blob) const;
444 
445  blobdata output_to_blob(const tx_out& output) const;
446  tx_out output_from_blob(const blobdata& blob) const;
447 
448  virtual void add_chainstate_utxo(const crypto::hash tx_hash, const uint32_t relative_out_index, const crypto::public_key combined_key, uint64_t amount, uint64_t unlock_time, bool is_coinbase = false);
449  virtual bool check_chainstate_utxo(const crypto::hash tx_hash, const uint32_t relative_out_index);
450  virtual uint64_t get_utxo_unlock_time(const crypto::hash tx_hash, const uint32_t relative_out_index);
451  virtual void remove_chainstate_utxo(const crypto::hash tx_hash, const uint32_t relative_out_index);
452 
453  virtual void add_addr_output(const crypto::hash tx_hash, const uint32_t relative_out_index, const crypto::public_key& combined_key, uint64_t amount, uint64_t unlock_time);
454  virtual void remove_addr_output(const crypto::hash tx_hash, const uint32_t relative_out_index, const crypto::public_key& combined_key, uint64_t amount, uint64_t unlock_time);
455 
456  virtual void add_addr_tx(const crypto::hash tx_hash, const crypto::public_key& combined_key);
457  virtual void remove_addr_tx(const crypto::hash tx_hash, const crypto::public_key& combined_key);
458 
459  virtual void add_tx_input(const crypto::hash tx_hash, const uint32_t relative_out_index, const crypto::hash parent_tx_hash, const uint64_t in_index);
460  virtual void remove_tx_input(const crypto::hash tx_hash, const uint32_t relative_out_index);
461 
462  // migrate from older DB version to current
463  void migrate(const uint32_t oldversion);
464 
465  // migrate from DB version 0 to 1
466  void migrate_0_1();
467 
468  // migrate from DB version 1 to 2
469  void migrate_1_2();
470 
471  // migrate from DB version 2 to 3
472  void migrate_2_3();
473 
474  // migrate from DB version 3 to 4
475  void migrate_3_4();
476 
477  // migrate from DB version 4 to 5
478  void migrate_4_5();
479 
480  void cleanup_batch();
481 
482 private:
483  MDB_env* m_env;
484 
485  MDB_dbi m_blocks;
486  MDB_dbi m_block_heights;
487  MDB_dbi m_block_info;
488 
489  MDB_dbi m_txs;
490  MDB_dbi m_txs_pruned;
491  MDB_dbi m_txs_prunable;
492  MDB_dbi m_txs_prunable_hash;
493  MDB_dbi m_txs_prunable_tip;
494  MDB_dbi m_tx_indices;
495  MDB_dbi m_tx_outputs;
496 
497  MDB_dbi m_output_txs;
498  MDB_dbi m_output_amounts;
499 
500  MDB_dbi m_spent_keys;
501 
502  MDB_dbi m_txpool_meta;
503  MDB_dbi m_txpool_blob;
504 
505  MDB_dbi m_hf_starting_heights;
506  MDB_dbi m_hf_versions;
507 
508  MDB_dbi m_validators;
509  MDB_dbi m_utxos;
510  MDB_dbi m_addr_outputs;
511  MDB_dbi m_addr_txs;
512  MDB_dbi m_addr_txs_old;
513  MDB_dbi m_tx_inputs;
514 
515  MDB_dbi m_properties;
516 
517  mutable uint64_t m_cum_size; // used in batch size estimation
518  mutable unsigned int m_cum_count;
519  std::string m_folder;
520  mdb_txn_safe* m_write_txn; // may point to either a short-lived txn or a batch txn
521  mdb_txn_safe* m_write_batch_txn; // persist batch txn outside of BlockchainLMDB
522  boost::thread::id m_writer;
523 
524  bool m_batch_transactions; // support for batch transactions
525  bool m_batch_active; // whether batch transaction is in progress
526 
527  mdb_txn_cursors m_wcursors;
528  mutable boost::thread_specific_ptr<mdb_threadinfo> m_tinfo;
529 
530 #if defined(__arm__)
531  // force a value so it can compile with 32-bit ARM
532  constexpr static uint64_t DEFAULT_MAPSIZE = 1LL << 31;
533 #else
534 #if defined(ENABLE_AUTO_RESIZE)
535  constexpr static uint64_t DEFAULT_MAPSIZE = 1LL << 30;
536 #else
537  constexpr static uint64_t DEFAULT_MAPSIZE = 1LL << 33;
538 #endif
539 #endif
540 
541  constexpr static float RESIZE_PERCENT = 0.9f;
542 };
543 
544 } // namespace cryptonote
virtual void block_wtxn_start()
Definition: db_lmdb.cpp:4406
virtual void safesyncmode(const bool onoff)
toggle safe syncs for the DB
Definition: db_lmdb.cpp:1656
MDB_cursor * m_txc_txpool_blob
Definition: db_lmdb.h:69
virtual bool get_tx_blob(const crypto::hash &h, cryptonote::blobdata &tx) const
fetches the transaction blob with the given hash
Definition: db_lmdb.cpp:3655
virtual void set_batch_transactions(bool batch_transactions)
sets whether or not to batch transactions
Definition: db_lmdb.cpp:4343
bool is_coinbase(const transaction &tx)
MDB_cursor * m_txc_utxos
Definition: db_lmdb.h:75
mdb_threadinfo * m_tinfo
Definition: db_lmdb.h:170
virtual std::vector< std::string > get_filenames() const
get all files used by the BlockchainDB (if any)
Definition: db_lmdb.cpp:1724
virtual std::vector< address_outputs > get_addr_output_all(const crypto::public_key &combined_key)
Definition: db_lmdb.cpp:2071
virtual uint64_t get_tx_unlock_time(const crypto::hash &h) const
fetch a transaction&#39;s unlock time/height
Definition: db_lmdb.cpp:3634
virtual std::vector< transaction > get_tx_list(const std::vector< crypto::hash > &hlist) const
fetches a list of transactions based on their hashes
Definition: db_lmdb.cpp:3798
virtual void block_rtxn_abort() const
Definition: db_lmdb.cpp:4477
virtual uint64_t get_block_long_term_weight(const uint64_t &height) const
fetch a block&#39;s long term weight
Definition: db_lmdb.cpp:3428
Lightning memory-mapped database library.
static int compare_hash32(const MDB_val *a, const MDB_val *b)
Definition: db_lmdb.cpp:151
tx_data_t data
Definition: db_lmdb.h:46
MDB_cursor * m_txc_properties
Definition: db_lmdb.h:73
virtual void set_block_cumulative_difficulty(uint64_t height, difficulty_type diff)
sets a block&#39;s cumulative difficulty
Definition: db_lmdb.cpp:3327
::std::string string
Definition: gtest-port.h:1097
struct cryptonote::txindex txindex
MDB_cursor * m_txc_txs
Definition: db_lmdb.h:58
virtual std::string get_db_name() const
gets the name of the folder the BlockchainDB&#39;s file(s) should be in
Definition: db_lmdb.cpp:1755
MDB_cursor * m_txc_output_amounts
Definition: db_lmdb.h:56
MDB_cursor * m_txc_hf_versions
Definition: db_lmdb.h:71
virtual uint64_t get_balance(const crypto::public_key &combined_key)
Definition: db_lmdb.cpp:2298
BlockchainLMDB(bool batch_transactions=true)
Definition: db_lmdb.cpp:1338
virtual block_header get_block_header(const crypto::hash &h) const
fetch a block header
Definition: db_lmdb.cpp:3053
crypto::hash key
Definition: db_lmdb.h:45
virtual bool for_all_outputs(std::function< bool(uint64_t amount, const crypto::hash &tx_hash, uint64_t height, size_t tx_idx)> f) const
runs a function over all outputs stored
Definition: db_lmdb.cpp:4135
virtual std::vector< address_txs > get_addr_tx_all(const crypto::public_key &combined_key)
Definition: db_lmdb.cpp:2214
virtual bool batch_start(uint64_t batch_num_blocks=0, uint64_t batch_bytes=0)
tells the BlockchainDB to start a new "batch" of blocks
Definition: db_lmdb.cpp:4211
virtual bool update_pruning()
prunes recent blockchain changes as needed, iff pruning is enabled
Definition: db_lmdb.cpp:2931
Non-owning sequence of data. Does not deep copy.
Definition: span.h:56
MDB_cursor * m_txc_block_info
Definition: db_lmdb.h:53
struct cryptonote::mdb_rflags mdb_rflags
struct MDB_env MDB_env
Opaque structure for a database environment.
Definition: lmdb.h:260
virtual void add_txpool_tx(const crypto::hash &txid, const cryptonote::blobdata &blob, const txpool_tx_meta_t &meta)
add a txpool transaction
Definition: db_lmdb.cpp:2415
unsigned char uint8_t
Definition: stdint.h:124
virtual std::vector< std::vector< uint64_t > > get_tx_amount_output_indices(const uint64_t tx_id, size_t n_txes) const
gets output indices (amount-specific) for a transaction&#39;s outputs
Definition: db_lmdb.cpp:3929
static int compare_data(const MDB_val *a, const MDB_val *b)
Definition: db_lmdb.cpp:172
virtual void pop_block(block &blk, std::vector< transaction > &txs)
pops the top block off the blockchain
Definition: db_lmdb.cpp:4513
virtual uint64_t get_block_height(const crypto::hash &h) const
gets the height of the block with a given hash
Definition: db_lmdb.cpp:3032
mdb_txn_safe(const bool check=true)
Definition: db_lmdb.cpp:407
MDB_cursor * m_txc_txs_prunable_hash
Definition: db_lmdb.h:61
MDB_cursor * m_txc_txpool_meta
Definition: db_lmdb.h:68
virtual bool block_rtxn_start() const
Definition: db_lmdb.cpp:4399
virtual bool tx_exists(const crypto::hash &h) const
check if a transaction with a given hash exists
Definition: db_lmdb.cpp:3568
virtual bool get_txpool_tx_meta(const crypto::hash &txid, txpool_tx_meta_t &meta) const
get a txpool transaction&#39;s metadata
Definition: db_lmdb.cpp:2558
virtual bool can_thread_bulk_indices() const
Definition: db_lmdb.h:342
MDB_cursor * m_txc_spent_keys
Definition: db_lmdb.h:66
MDB_cursor * m_txc_txs_prunable
Definition: db_lmdb.h:60
struct MDB_txn MDB_txn
Opaque structure for a transaction handle.
Definition: lmdb.h:267
virtual tx_input_t get_tx_input(const crypto::hash tx_hash, const uint32_t relative_out_index)
Definition: db_lmdb.cpp:1973
virtual bool txpool_has_tx(const crypto::hash &txid) const
check whether a txid is in the txpool
Definition: db_lmdb.cpp:2512
virtual difficulty_type get_block_difficulty(const uint64_t &height) const
fetch a block&#39;s difficulty
Definition: db_lmdb.cpp:3388
Holds cryptonote related classes and helpers.
Definition: ban.cpp:40
virtual bool get_prunable_tx_hash(const crypto::hash &tx_hash, crypto::hash &prunable_hash) const
fetches the prunable transaction hash
Definition: db_lmdb.cpp:3751
virtual std::vector< block > get_blocks_range(const uint64_t &h1, const uint64_t &h2) const
fetch a list of blocks
Definition: db_lmdb.cpp:3474
virtual tx_out_index get_output_tx_and_index_from_global(const uint64_t &index) const
gets an output&#39;s tx hash and index
Definition: db_lmdb.cpp:3893
MDB_cursor * m_txc_validators
Definition: db_lmdb.h:74
mdb_size_t count(MDB_cursor *cur)
virtual uint32_t get_blockchain_pruning_seed() const
get the blockchain pruning seed
Definition: db_lmdb.cpp:2608
static std::atomic_flag creation_gate
Definition: db_lmdb.h:177
virtual uint64_t get_block_already_generated_coins(const uint64_t &height) const
fetch a block&#39;s already generated coins
Definition: db_lmdb.cpp:3405
virtual void block_rtxn_stop() const
Definition: db_lmdb.cpp:4392
void commit(std::string message="")
Definition: db_lmdb.cpp:453
virtual bool block_exists(const crypto::hash &h, uint64_t *height=NULL) const
checks if a block exists
Definition: db_lmdb.cpp:2993
unsigned int uint32_t
Definition: stdint.h:126
virtual bool for_all_key_images(std::function< bool(const crypto::key_image &)>) const
runs a function over all key images stored
Definition: db_lmdb.cpp:3989
MDB_cursor * m_txc_tx_outputs
Definition: db_lmdb.h:64
virtual bool get_prunable_tx_blob(const crypto::hash &h, cryptonote::blobdata &tx) const
fetches the prunable transaction blob with the given hash
Definition: db_lmdb.cpp:3721
static int compare_uint64(const MDB_val *a, const MDB_val *b)
Definition: db_lmdb.cpp:143
virtual void update_txpool_tx(const crypto::hash &txid, const txpool_tx_meta_t &meta)
update a txpool transaction&#39;s metadata
Definition: db_lmdb.cpp:2441
virtual size_t get_block_weight(const uint64_t &height) const
fetch a block&#39;s weight
Definition: db_lmdb.cpp:3188
virtual void close()
close the BlockchainDB
Definition: db_lmdb.cpp:1624
virtual bool get_txpool_tx_blob(const crypto::hash &txid, cryptonote::blobdata &bd) const
get a txpool transaction&#39;s blob
Definition: db_lmdb.cpp:2579
unsigned __int64 uint64_t
Definition: stdint.h:136
virtual uint64_t add_block(const std::pair< block, blobdata > &blk, size_t block_weight, uint64_t long_term_block_weight, const difficulty_type &cumulative_difficulty, const uint64_t &coins_generated, const std::vector< std::pair< transaction, blobdata >> &txs)
handles the addition of a new block to BlockchainDB
Definition: db_lmdb.cpp:4484
virtual std::vector< address_txs > get_addr_tx_batch(const crypto::public_key &combined_key, uint64_t start_db_index=0, uint64_t batch_size=100, bool desc=false)
Definition: db_lmdb.cpp:2249
static void wait_no_active_txns()
Definition: db_lmdb.cpp:492
virtual void batch_stop()
ends a batch transaction
Definition: db_lmdb.cpp:4291
virtual bool remove_data_file(const std::string &folder) const
remove file(s) storing the database
Definition: db_lmdb.cpp:1740
virtual uint64_t get_block_timestamp(const uint64_t &height) const
fetch a block&#39;s timestamp
Definition: db_lmdb.cpp:3088
unsigned int MDB_dbi
A handle for an individual database in the DB environment.
Definition: lmdb.h:270
std::map< uint64_t, std::tuple< uint64_t, uint64_t, uint64_t > > get_output_histogram(const std::vector< uint64_t > &amounts, bool unlocked, uint64_t recent_cutoff, uint64_t min_count) const
return a histogram of outputs on the blockchain
Definition: db_lmdb.cpp:4651
virtual uint64_t get_txpool_tx_count(bool include_unrelayed_txes=true) const
get the number of transactions in the txpool
Definition: db_lmdb.cpp:2467
virtual bool lock()
acquires the BlockchainDB lock
Definition: db_lmdb.cpp:1763
virtual void unlock()
This function releases the BlockchainDB lock.
Definition: db_lmdb.cpp:1771
POD_CLASS public_key
Definition: crypto.h:76
version
Supported socks variants.
Definition: socks.h:57
virtual difficulty_type get_block_cumulative_difficulty(const uint64_t &height) const
fetch a block&#39;s cumulative difficulty
Definition: db_lmdb.cpp:3363
std::string message("Message requiring signing")
virtual void open(const std::string &filename, const int mdb_flags=0)
open a db, or create it if necessary.
Definition: db_lmdb.cpp:1357
mdb_txn_cursors m_ti_rcursors
Definition: db_lmdb.h:134
const GenericPointer< typename T::ValueType > T2 T::AllocatorType & a
Definition: pointer.h:1124
std::string blobdata
Definition: blobdatatype.h:39
virtual bool for_all_txpool_txes(std::function< bool(const crypto::hash &, const txpool_tx_meta_t &, const cryptonote::blobdata *)> f, bool include_blob=false, bool include_unrelayed_txes=true) const
runs a function over all txpool transactions
Definition: db_lmdb.cpp:2941
struct MDB_cursor MDB_cursor
Opaque structure for navigating through a database.
Definition: lmdb.h:273
virtual void remove_txpool_tx(const crypto::hash &txid)
remove a txpool transaction
Definition: db_lmdb.cpp:2528
The BlockchainDB backing store interface declaration/contract.
Generic structure used for passing keys and data in and out of the database.
Definition: lmdb.h:286
static int compare_publickey(const MDB_val *a, const MDB_val *b)
Definition: db_lmdb.cpp:188
boost::multiprecision::uint128_t difficulty_type
Definition: difficulty.h:43
MDB_cursor * m_txc_txs_prunable_tip
Definition: db_lmdb.h:62
POD_CLASS key_image
Definition: crypto.h:102
a struct containing txpool per transaction metadata
virtual bool prune_blockchain(uint32_t pruning_seed=0)
prunes the blockchain
Definition: db_lmdb.cpp:2926
virtual cryptonote::blobdata get_block_blob_from_height(const uint64_t &height) const
fetch a block blob by height
Definition: db_lmdb.cpp:3062
MDB_cursor * m_txc_txs_pruned
Definition: db_lmdb.h:59
virtual void batch_abort()
aborts a batch transaction
Definition: db_lmdb.cpp:4320
virtual bool for_all_transactions(std::function< bool(const crypto::hash &, const cryptonote::transaction &)>, bool pruned) const
runs a function over all transactions stored
Definition: db_lmdb.cpp:4073
virtual std::vector< crypto::hash > get_hashes_range(const uint64_t &h1, const uint64_t &h2) const
fetch a list of block hashes
Definition: db_lmdb.cpp:3488
virtual block get_top_block() const
fetch the top block
Definition: db_lmdb.cpp:3517
virtual uint64_t get_top_block_timestamp() const
fetch the top block&#39;s timestamp
Definition: db_lmdb.cpp:3173
virtual bool for_blocks_range(const uint64_t &h1, const uint64_t &h2, std::function< bool(uint64_t, const crypto::hash &, const cryptonote::block &)>) const
runs a function over a range of blocks
Definition: db_lmdb.cpp:4022
POD_CLASS hash
Definition: hash.h:50
virtual crypto::hash get_block_hash_from_height(const uint64_t &height) const
fetch a block&#39;s hash
Definition: db_lmdb.cpp:3451
virtual void batch_commit()
Definition: db_lmdb.cpp:4254
std::pair< crypto::hash, uint64_t > tx_out_index
uint64_t num_active_tx() const
Definition: db_lmdb.cpp:482
struct cryptonote::mdb_txn_cursors mdb_txn_cursors
static void prevent_new_txns()
Definition: db_lmdb.cpp:487
MDB_cursor * m_txc_tx_inputs
Definition: db_lmdb.h:78
virtual void sync()
sync the BlockchainDB with disk
Definition: db_lmdb.cpp:1640
virtual cryptonote::blobdata get_block_blob(const crypto::hash &h) const
fetches the block with the given hash
Definition: db_lmdb.cpp:3024
MDB_cursor * m_txc_tx_indices
Definition: db_lmdb.h:63
virtual std::vector< uint64_t > get_long_term_block_weights(uint64_t start_height, size_t count) const
fetch the last N blocks&#39; long term weights
Definition: db_lmdb.cpp:3322
MDB_cursor * m_txc_block_heights
Definition: db_lmdb.h:52
virtual uint64_t get_tx_block_height(const crypto::hash &h) const
fetches the height of a transaction&#39;s block
Definition: db_lmdb.cpp:3812
virtual uint64_t get_num_outputs(const uint64_t &amount) const
fetches the number of outputs of a given amount
Definition: db_lmdb.cpp:3835
virtual std::vector< address_outputs > get_addr_output_batch(const crypto::public_key &combined_key, uint64_t start_db_index=0, uint64_t batch_size=100, bool desc=false)
Definition: db_lmdb.cpp:2112
virtual bool has_key_image(const crypto::key_image &img) const
check if a key image is stored as spent
Definition: db_lmdb.cpp:3972
a struct containing output metadata
struct cryptonote::mdb_threadinfo mdb_threadinfo
virtual output_data_t get_output_key(const uint64_t &amount, const uint64_t &index, bool include_commitmemt) const
get some of an output&#39;s data
Definition: db_lmdb.cpp:3859
MDB_cursor * m_txc_addr_txs
Definition: db_lmdb.h:77
bool get_output_distribution(uint64_t amount, uint64_t from_height, uint64_t to_height, std::vector< uint64_t > &distribution, uint64_t &base) const
Definition: db_lmdb.cpp:4744
virtual void reset()
Remove everything from the BlockchainDB.
Definition: db_lmdb.cpp:1662
virtual void block_wtxn_stop()
Definition: db_lmdb.cpp:4439
MDB_cursor * m_txc_blocks
Definition: db_lmdb.h:51
MDB_cursor * m_txc_output_txs
Definition: db_lmdb.h:55
static int compare_string(const MDB_val *a, const MDB_val *b)
Definition: db_lmdb.cpp:165
virtual uint64_t get_tx_count() const
fetches the total number of transactions ever
Definition: db_lmdb.cpp:3781
virtual uint64_t height() const
fetch the current blockchain height
Definition: db_lmdb.cpp:3532
virtual std::vector< uint64_t > get_block_weights(uint64_t start_height, size_t count) const
fetch the last N blocks&#39; weights
Definition: db_lmdb.cpp:3317
virtual std::vector< uint64_t > get_block_cumulative_rct_outputs(const std::vector< uint64_t > &heights) const
fetch a block&#39;s cumulative number of rct outputs
Definition: db_lmdb.cpp:3111
MDB_cursor * m_txc_addr_outputs
Definition: db_lmdb.h:76
static std::atomic< uint64_t > num_active_txns
Definition: db_lmdb.h:174
static void allow_new_txns()
Definition: db_lmdb.cpp:497
virtual bool get_pruned_tx_blob(const crypto::hash &h, cryptonote::blobdata &tx) const
fetches the pruned transaction blob with the given hash
Definition: db_lmdb.cpp:3691
virtual bool check_pruning()
checks pruning was done correctly, iff enabled
Definition: db_lmdb.cpp:2936
virtual void block_wtxn_abort()
Definition: db_lmdb.cpp:4461
virtual tx_out_index get_output_tx_and_index(const uint64_t &amount, const uint64_t &index) const
gets an output&#39;s tx hash and index
Definition: db_lmdb.cpp:3916
virtual crypto::hash top_block_hash(uint64_t *block_height=NULL) const
fetch the top block&#39;s hash
Definition: db_lmdb.cpp:3502