mirror of
https://github.com/monero-project/monero.git
synced 2025-07-25 06:15:24 -04:00
Moved BlockchainDB into its own src/ subfolder
Ostensibly janitorial work, but should be more relevant later down the
line. Things that depend on core cryptonote things (i.e.
cryptonote_core) don't necessarily depend on BlockchainDB and thus
have no need to have BlockchainDB baked in with them.
This commit is contained in:
Thomas Winget
parent
0ad0784f46
commit
5eab480cb1
12 changed files with 72 additions and 13 deletions
File diff suppressed because it is too large
Load diff
|
|
@ -1,314 +0,0 @@
|
|||
// Copyright (c) 2014, The Monero Project
|
||||
// All rights reserved.
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without modification, are
|
||||
// permitted provided that the following conditions are met:
|
||||
//
|
||||
// 1. Redistributions of source code must retain the above copyright notice, this list of
|
||||
// conditions and the following disclaimer.
|
||||
//
|
||||
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
|
||||
// of conditions and the following disclaimer in the documentation and/or other
|
||||
// materials provided with the distribution.
|
||||
//
|
||||
// 3. Neither the name of the copyright holder nor the names of its contributors may be
|
||||
// used to endorse or promote products derived from this software without specific
|
||||
// prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
|
||||
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
||||
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||||
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||||
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
||||
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
#include "cryptonote_core/blockchain_db.h"
|
||||
#include "cryptonote_protocol/blobdatatype.h" // for type blobdata
|
||||
|
||||
#include <lmdb.h>
|
||||
|
||||
namespace cryptonote
|
||||
{
|
||||
|
||||
struct txn_safe
|
||||
{
|
||||
txn_safe() : m_txn(NULL) { }
|
||||
~txn_safe()
|
||||
{
|
||||
LOG_PRINT_L3("txn_safe: destructor");
|
||||
if (m_txn != NULL)
|
||||
{
|
||||
if (m_batch_txn) // this is a batch txn and should have been handled before this point for safety
|
||||
{
|
||||
LOG_PRINT_L0("WARNING: txn_safe: m_txn is a batch txn and it's not NULL in destructor - calling mdb_txn_abort()");
|
||||
}
|
||||
else
|
||||
{
|
||||
// Example of when this occurs: a lookup fails, so a read-only txn is
|
||||
// aborted through this destructor. However, successful read-only txns
|
||||
// ideally should have been committed when done and not end up here.
|
||||
//
|
||||
// NOTE: not sure if this is ever reached for a non-batch write
|
||||
// transaction, but it's probably not ideal if it did.
|
||||
LOG_PRINT_L3("txn_safe: m_txn not NULL in destructor - calling mdb_txn_abort()");
|
||||
}
|
||||
mdb_txn_abort(m_txn);
|
||||
}
|
||||
}
|
||||
|
||||
void commit(std::string message = "")
|
||||
{
|
||||
if (message.size() == 0)
|
||||
{
|
||||
message = "Failed to commit a transaction to the db";
|
||||
}
|
||||
|
||||
if (mdb_txn_commit(m_txn))
|
||||
{
|
||||
m_txn = NULL;
|
||||
LOG_PRINT_L0(message);
|
||||
throw DB_ERROR(message.c_str());
|
||||
}
|
||||
m_txn = NULL;
|
||||
}
|
||||
|
||||
// This should only be needed for batch transaction which must be ensured to
|
||||
// be aborted before mdb_env_close, not after. So we can't rely on
|
||||
// BlockchainLMDB destructor to call txn_safe destructor, as that's too late
|
||||
// to properly abort, since mdb_env_close would have been called earlier.
|
||||
void abort()
|
||||
{
|
||||
LOG_PRINT_L3("txn_safe: abort()");
|
||||
if(m_txn != NULL)
|
||||
{
|
||||
mdb_txn_abort(m_txn);
|
||||
m_txn = NULL;
|
||||
}
|
||||
else
|
||||
{
|
||||
LOG_PRINT_L0("WARNING: txn_safe: abort() called, but m_txn is NULL");
|
||||
}
|
||||
}
|
||||
|
||||
operator MDB_txn*()
|
||||
{
|
||||
return m_txn;
|
||||
}
|
||||
|
||||
operator MDB_txn**()
|
||||
{
|
||||
return &m_txn;
|
||||
}
|
||||
|
||||
MDB_txn* m_txn;
|
||||
bool m_batch_txn = false;
|
||||
};
|
||||
|
||||
|
||||
class BlockchainLMDB : public BlockchainDB
|
||||
{
|
||||
public:
|
||||
BlockchainLMDB(bool batch_transactions=false);
|
||||
~BlockchainLMDB();
|
||||
|
||||
virtual void open(const std::string& filename);
|
||||
|
||||
virtual void create(const std::string& filename);
|
||||
|
||||
virtual void close();
|
||||
|
||||
virtual void sync();
|
||||
|
||||
virtual void reset();
|
||||
|
||||
virtual std::vector<std::string> get_filenames() const;
|
||||
|
||||
virtual bool lock();
|
||||
|
||||
virtual void unlock();
|
||||
|
||||
virtual bool block_exists(const crypto::hash& h) const;
|
||||
|
||||
virtual block get_block(const crypto::hash& h) const;
|
||||
|
||||
virtual uint64_t get_block_height(const crypto::hash& h) const;
|
||||
|
||||
virtual block_header get_block_header(const crypto::hash& h) const;
|
||||
|
||||
virtual block get_block_from_height(const uint64_t& height) const;
|
||||
|
||||
virtual uint64_t get_block_timestamp(const uint64_t& height) const;
|
||||
|
||||
virtual uint64_t get_top_block_timestamp() const;
|
||||
|
||||
virtual size_t get_block_size(const uint64_t& height) const;
|
||||
|
||||
virtual difficulty_type get_block_cumulative_difficulty(const uint64_t& height) const;
|
||||
|
||||
virtual difficulty_type get_block_difficulty(const uint64_t& height) const;
|
||||
|
||||
virtual uint64_t get_block_already_generated_coins(const uint64_t& height) const;
|
||||
|
||||
virtual crypto::hash get_block_hash_from_height(const uint64_t& height) const;
|
||||
|
||||
virtual std::vector<block> get_blocks_range(const uint64_t& h1, const uint64_t& h2) const;
|
||||
|
||||
virtual std::vector<crypto::hash> get_hashes_range(const uint64_t& h1, const uint64_t& h2) const;
|
||||
|
||||
virtual crypto::hash top_block_hash() const;
|
||||
|
||||
virtual block get_top_block() const;
|
||||
|
||||
virtual uint64_t height() const;
|
||||
|
||||
virtual bool tx_exists(const crypto::hash& h) const;
|
||||
|
||||
virtual uint64_t get_tx_unlock_time(const crypto::hash& h) const;
|
||||
|
||||
virtual transaction get_tx(const crypto::hash& h) const;
|
||||
|
||||
virtual uint64_t get_tx_count() const;
|
||||
|
||||
virtual std::vector<transaction> get_tx_list(const std::vector<crypto::hash>& hlist) const;
|
||||
|
||||
virtual uint64_t get_tx_block_height(const crypto::hash& h) const;
|
||||
|
||||
virtual uint64_t get_random_output(const uint64_t& amount) const;
|
||||
|
||||
virtual uint64_t get_num_outputs(const uint64_t& amount) const;
|
||||
|
||||
virtual crypto::public_key get_output_key(const uint64_t& amount, const uint64_t& index) const;
|
||||
|
||||
virtual tx_out get_output(const crypto::hash& h, const uint64_t& index) const;
|
||||
|
||||
/**
|
||||
* @brief get an output from its global index
|
||||
*
|
||||
* @param index global index of the output desired
|
||||
*
|
||||
* @return the output associated with the index.
|
||||
* Will throw OUTPUT_DNE if not output has that global index.
|
||||
* Will throw DB_ERROR if there is a non-specific LMDB error in fetching
|
||||
*/
|
||||
tx_out get_output(const uint64_t& index) const;
|
||||
|
||||
virtual tx_out_index get_output_tx_and_index_from_global(const uint64_t& index) const;
|
||||
|
||||
virtual tx_out_index get_output_tx_and_index(const uint64_t& amount, const uint64_t& index) const;
|
||||
|
||||
virtual std::vector<uint64_t> get_tx_output_indices(const crypto::hash& h) const;
|
||||
virtual std::vector<uint64_t> get_tx_amount_output_indices(const crypto::hash& h) const;
|
||||
|
||||
virtual bool has_key_image(const crypto::key_image& img) const;
|
||||
|
||||
virtual uint64_t add_block( const block& blk
|
||||
, const size_t& block_size
|
||||
, const difficulty_type& cumulative_difficulty
|
||||
, const uint64_t& coins_generated
|
||||
, const std::vector<transaction>& txs
|
||||
);
|
||||
|
||||
virtual void set_batch_transactions(bool batch_transactions);
|
||||
virtual void batch_start();
|
||||
virtual void batch_commit();
|
||||
virtual void batch_stop();
|
||||
virtual void batch_abort();
|
||||
|
||||
virtual void pop_block(block& blk, std::vector<transaction>& txs);
|
||||
|
||||
private:
|
||||
virtual void add_block( const block& blk
|
||||
, const size_t& block_size
|
||||
, const difficulty_type& cumulative_difficulty
|
||||
, const uint64_t& coins_generated
|
||||
, const crypto::hash& block_hash
|
||||
);
|
||||
|
||||
virtual void remove_block();
|
||||
|
||||
virtual void add_transaction_data(const crypto::hash& blk_hash, const transaction& tx, const crypto::hash& tx_hash);
|
||||
|
||||
virtual void remove_transaction_data(const crypto::hash& tx_hash, const transaction& tx);
|
||||
|
||||
virtual void add_output(const crypto::hash& tx_hash, const tx_out& tx_output, const uint64_t& local_index);
|
||||
|
||||
virtual void remove_output(const tx_out& tx_output);
|
||||
|
||||
void remove_tx_outputs(const crypto::hash& tx_hash, const transaction& tx);
|
||||
|
||||
void remove_output(const uint64_t& out_index, const uint64_t amount);
|
||||
void remove_amount_output_index(const uint64_t amount, const uint64_t global_output_index);
|
||||
|
||||
virtual void add_spent_key(const crypto::key_image& k_image);
|
||||
|
||||
virtual void remove_spent_key(const crypto::key_image& k_image);
|
||||
|
||||
/**
|
||||
* @brief convert a tx output to a blob for storage
|
||||
*
|
||||
* @param output the output to convert
|
||||
*
|
||||
* @return the resultant blob
|
||||
*/
|
||||
blobdata output_to_blob(const tx_out& output);
|
||||
|
||||
/**
|
||||
* @brief convert a tx output blob to a tx output
|
||||
*
|
||||
* @param blob the blob to convert
|
||||
*
|
||||
* @return the resultant tx output
|
||||
*/
|
||||
tx_out output_from_blob(const blobdata& blob) const;
|
||||
|
||||
/**
|
||||
* @brief get the global index of the index-th output of the given amount
|
||||
*
|
||||
* @param amount the output amount
|
||||
* @param index the index into the set of outputs of that amount
|
||||
*
|
||||
* @return the global index of the desired output
|
||||
*/
|
||||
uint64_t get_output_global_index(const uint64_t& amount, const uint64_t& index) const;
|
||||
|
||||
void check_open() const;
|
||||
|
||||
MDB_env* m_env;
|
||||
|
||||
MDB_dbi m_blocks;
|
||||
MDB_dbi m_block_heights;
|
||||
MDB_dbi m_block_hashes;
|
||||
MDB_dbi m_block_timestamps;
|
||||
MDB_dbi m_block_sizes;
|
||||
MDB_dbi m_block_diffs;
|
||||
MDB_dbi m_block_coins;
|
||||
|
||||
MDB_dbi m_txs;
|
||||
MDB_dbi m_tx_unlocks;
|
||||
MDB_dbi m_tx_heights;
|
||||
MDB_dbi m_tx_outputs;
|
||||
|
||||
MDB_dbi m_output_txs;
|
||||
MDB_dbi m_output_indices;
|
||||
MDB_dbi m_output_gindices;
|
||||
MDB_dbi m_output_amounts;
|
||||
MDB_dbi m_output_keys;
|
||||
MDB_dbi m_outputs;
|
||||
|
||||
MDB_dbi m_spent_keys;
|
||||
|
||||
bool m_open;
|
||||
uint64_t m_height;
|
||||
uint64_t m_num_outputs;
|
||||
std::string m_folder;
|
||||
txn_safe* m_write_txn; // may point to either a short-lived txn or a batch txn
|
||||
txn_safe m_write_batch_txn; // persist batch txn outside of BlockchainLMDB
|
||||
|
||||
bool m_batch_transactions; // support for batch transactions
|
||||
bool m_batch_active; // whether batch transaction is in progress
|
||||
};
|
||||
|
||||
} // namespace cryptonote
|
||||
|
|
@ -30,8 +30,6 @@ set(cryptonote_core_sources
|
|||
account.cpp
|
||||
blockchain_storage.cpp
|
||||
blockchain.cpp
|
||||
blockchain_db.cpp
|
||||
BlockchainDB_impl/db_lmdb.cpp
|
||||
checkpoints.cpp
|
||||
checkpoints_create.cpp
|
||||
cryptonote_basic_impl.cpp
|
||||
|
|
@ -49,8 +47,6 @@ set(cryptonote_core_private_headers
|
|||
blockchain_storage.h
|
||||
blockchain_storage_boost_serialization.h
|
||||
blockchain.h
|
||||
blockchain_db.h
|
||||
BlockchainDB_impl/db_lmdb.h
|
||||
checkpoints.h
|
||||
checkpoints_create.h
|
||||
connection_context.h
|
||||
|
|
@ -76,6 +72,7 @@ target_link_libraries(cryptonote_core
|
|||
LINK_PUBLIC
|
||||
common
|
||||
crypto
|
||||
blockchain_db
|
||||
${Boost_DATE_TIME_LIBRARY}
|
||||
${Boost_PROGRAM_OPTIONS_LIBRARY}
|
||||
${Boost_SERIALIZATION_LIBRARY}
|
||||
|
|
@ -83,5 +80,4 @@ target_link_libraries(cryptonote_core
|
|||
${Boost_FILESYSTEM_LIBRARY}
|
||||
${Boost_SYSTEM_LIBRARY}
|
||||
${Boost_THREAD_LIBRARY}
|
||||
${LMDB_LIBRARY}
|
||||
${EXTRA_LIBRARIES})
|
||||
|
|
|
|||
|
|
@ -38,8 +38,8 @@
|
|||
#include "cryptonote_basic_impl.h"
|
||||
#include "tx_pool.h"
|
||||
#include "blockchain.h"
|
||||
#include "cryptonote_core/blockchain_db.h"
|
||||
#include "cryptonote_core/BlockchainDB_impl/db_lmdb.h"
|
||||
#include "blockchain_db/blockchain_db.h"
|
||||
#include "blockchain_db/lmdb/db_lmdb.h"
|
||||
#include "cryptonote_format_utils.h"
|
||||
#include "cryptonote_boost_serialization.h"
|
||||
#include "cryptonote_config.h"
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@
|
|||
#include "verification_context.h"
|
||||
#include "crypto/hash.h"
|
||||
#include "checkpoints.h"
|
||||
#include "blockchain_db.h"
|
||||
#include "blockchain_db/blockchain_db.h"
|
||||
|
||||
namespace cryptonote
|
||||
{
|
||||
|
|
|
|||
|
|
@ -1,180 +0,0 @@
|
|||
// Copyright (c) 2014, The Monero Project
|
||||
//
|
||||
// All rights reserved.
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without modification, are
|
||||
// permitted provided that the following conditions are met:
|
||||
//
|
||||
// 1. Redistributions of source code must retain the above copyright notice, this list of
|
||||
// conditions and the following disclaimer.
|
||||
//
|
||||
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
|
||||
// of conditions and the following disclaimer in the documentation and/or other
|
||||
// materials provided with the distribution.
|
||||
//
|
||||
// 3. Neither the name of the copyright holder nor the names of its contributors may be
|
||||
// used to endorse or promote products derived from this software without specific
|
||||
// prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
|
||||
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
||||
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||||
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||||
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
||||
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
#include "cryptonote_core/blockchain_db.h"
|
||||
#include "cryptonote_format_utils.h"
|
||||
#include "profile_tools.h"
|
||||
|
||||
using epee::string_tools::pod_to_hex;
|
||||
|
||||
namespace cryptonote
|
||||
{
|
||||
|
||||
void BlockchainDB::pop_block()
|
||||
{
|
||||
block blk;
|
||||
std::vector<transaction> txs;
|
||||
pop_block(blk, txs);
|
||||
}
|
||||
|
||||
void BlockchainDB::add_transaction(const crypto::hash& blk_hash, const transaction& tx, const crypto::hash* tx_hash_ptr)
|
||||
{
|
||||
crypto::hash tx_hash;
|
||||
if (!tx_hash_ptr)
|
||||
{
|
||||
// should only need to compute hash for miner transactions
|
||||
tx_hash = get_transaction_hash(tx);
|
||||
LOG_PRINT_L3("null tx_hash_ptr - needed to compute: " << tx_hash);
|
||||
}
|
||||
else
|
||||
{
|
||||
tx_hash = *tx_hash_ptr;
|
||||
}
|
||||
|
||||
add_transaction_data(blk_hash, tx, tx_hash);
|
||||
|
||||
// iterate tx.vout using indices instead of C++11 foreach syntax because
|
||||
// we need the index
|
||||
if (tx.vout.size() != 0) // it may be technically possible for a tx to have no outputs
|
||||
{
|
||||
for (uint64_t i = 0; i < tx.vout.size(); ++i)
|
||||
{
|
||||
add_output(tx_hash, tx.vout[i], i);
|
||||
}
|
||||
|
||||
for (const txin_v& tx_input : tx.vin)
|
||||
{
|
||||
if (tx_input.type() == typeid(txin_to_key))
|
||||
{
|
||||
add_spent_key(boost::get<txin_to_key>(tx_input).k_image);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
uint64_t BlockchainDB::add_block( const block& blk
|
||||
, const size_t& block_size
|
||||
, const difficulty_type& cumulative_difficulty
|
||||
, const uint64_t& coins_generated
|
||||
, const std::vector<transaction>& txs
|
||||
)
|
||||
{
|
||||
TIME_MEASURE_START(time1);
|
||||
crypto::hash blk_hash = get_block_hash(blk);
|
||||
TIME_MEASURE_FINISH(time1);
|
||||
time_blk_hash += time1;
|
||||
|
||||
// call out to subclass implementation to add the block & metadata
|
||||
time1 = epee::misc_utils::get_tick_count();
|
||||
add_block(blk, block_size, cumulative_difficulty, coins_generated, blk_hash);
|
||||
TIME_MEASURE_FINISH(time1);
|
||||
time_add_block1 += time1;
|
||||
|
||||
// call out to add the transactions
|
||||
|
||||
time1 = epee::misc_utils::get_tick_count();
|
||||
add_transaction(blk_hash, blk.miner_tx);
|
||||
int tx_i = 0;
|
||||
crypto::hash tx_hash = null_hash;
|
||||
for (const transaction& tx : txs)
|
||||
{
|
||||
tx_hash = blk.tx_hashes[tx_i];
|
||||
add_transaction(blk_hash, tx, &tx_hash);
|
||||
++tx_i;
|
||||
}
|
||||
TIME_MEASURE_FINISH(time1);
|
||||
time_add_transaction += time1;
|
||||
|
||||
++num_calls;
|
||||
|
||||
return height();
|
||||
}
|
||||
|
||||
void BlockchainDB::pop_block(block& blk, std::vector<transaction>& txs)
|
||||
{
|
||||
blk = get_top_block();
|
||||
|
||||
remove_block();
|
||||
|
||||
remove_transaction(get_transaction_hash(blk.miner_tx));
|
||||
for (const auto& h : blk.tx_hashes)
|
||||
{
|
||||
txs.push_back(get_tx(h));
|
||||
remove_transaction(h);
|
||||
}
|
||||
}
|
||||
|
||||
void BlockchainDB::remove_transaction(const crypto::hash& tx_hash)
|
||||
{
|
||||
transaction tx = get_tx(tx_hash);
|
||||
|
||||
for (const txin_v& tx_input : tx.vin)
|
||||
{
|
||||
if (tx_input.type() == typeid(txin_to_key))
|
||||
{
|
||||
remove_spent_key(boost::get<txin_to_key>(tx_input).k_image);
|
||||
}
|
||||
}
|
||||
|
||||
// need tx as tx.vout has the tx outputs, and the output amounts are needed
|
||||
remove_transaction_data(tx_hash, tx);
|
||||
}
|
||||
|
||||
void BlockchainDB::reset_stats()
|
||||
{
|
||||
num_calls = 0;
|
||||
time_blk_hash = 0;
|
||||
time_tx_exists = 0;
|
||||
time_add_block1 = 0;
|
||||
time_add_transaction = 0;
|
||||
time_commit1 = 0;
|
||||
}
|
||||
|
||||
void BlockchainDB::show_stats()
|
||||
{
|
||||
LOG_PRINT_L1(ENDL
|
||||
<< "*********************************"
|
||||
<< ENDL
|
||||
<< "num_calls: " << num_calls
|
||||
<< ENDL
|
||||
<< "time_blk_hash: " << time_blk_hash << "ms"
|
||||
<< ENDL
|
||||
<< "time_tx_exists: " << time_tx_exists << "ms"
|
||||
<< ENDL
|
||||
<< "time_add_block1: " << time_add_block1 << "ms"
|
||||
<< ENDL
|
||||
<< "time_add_transaction: " << time_add_transaction << "ms"
|
||||
<< ENDL
|
||||
<< "time_commit1: " << time_commit1 << "ms"
|
||||
<< ENDL
|
||||
<< "*********************************"
|
||||
<< ENDL
|
||||
);
|
||||
}
|
||||
|
||||
} // namespace cryptonote
|
||||
|
|
@ -1,487 +0,0 @@
|
|||
// Copyright (c) 2014, The Monero Project
|
||||
//
|
||||
// All rights reserved.
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without modification, are
|
||||
// permitted provided that the following conditions are met:
|
||||
//
|
||||
// 1. Redistributions of source code must retain the above copyright notice, this list of
|
||||
// conditions and the following disclaimer.
|
||||
//
|
||||
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
|
||||
// of conditions and the following disclaimer in the documentation and/or other
|
||||
// materials provided with the distribution.
|
||||
//
|
||||
// 3. Neither the name of the copyright holder nor the names of its contributors may be
|
||||
// used to endorse or promote products derived from this software without specific
|
||||
// prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
|
||||
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
||||
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||||
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||||
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
||||
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
#ifndef BLOCKCHAIN_DB_H
|
||||
#define BLOCKCHAIN_DB_H
|
||||
|
||||
#include <list>
|
||||
#include <string>
|
||||
#include <exception>
|
||||
#include "crypto/hash.h"
|
||||
#include "cryptonote_core/cryptonote_basic.h"
|
||||
#include "cryptonote_core/difficulty.h"
|
||||
|
||||
/* DB Driver Interface
|
||||
*
|
||||
* The DB interface is a store for the canonical block chain.
|
||||
* It serves as a persistent storage for the blockchain.
|
||||
*
|
||||
* For the sake of efficiency, the reference implementation will also
|
||||
* store some blockchain data outside of the blocks, such as spent
|
||||
* transfer key images, unspent transaction outputs, etc.
|
||||
*
|
||||
* Transactions are duplicated so that we don't have to fetch a whole block
|
||||
* in order to fetch a transaction from that block. If this is deemed
|
||||
* unnecessary later, this can change.
|
||||
*
|
||||
* Spent key images are duplicated outside of the blocks so it is quick
|
||||
* to verify an output hasn't already been spent
|
||||
*
|
||||
* Unspent transaction outputs are duplicated to quickly gather random
|
||||
* outputs to use for mixins
|
||||
*
|
||||
* IMPORTANT:
|
||||
* A concrete implementation of this interface should populate these
|
||||
* duplicated members! It is possible to have a partial implementation
|
||||
* of this interface call to private members of the interface to be added
|
||||
* later that will then populate as needed.
|
||||
*
|
||||
* General:
|
||||
* open()
|
||||
* close()
|
||||
* sync()
|
||||
* reset()
|
||||
*
|
||||
* Lock and unlock provided for reorg externally, and for block
|
||||
* additions internally, this way threaded reads are completely fine
|
||||
* unless the blockchain is changing.
|
||||
* bool lock()
|
||||
* unlock()
|
||||
*
|
||||
* vector<str> get_filenames()
|
||||
*
|
||||
* Blocks:
|
||||
* bool block_exists(hash)
|
||||
* height add_block(block, block_size, cumulative_difficulty, coins_generated, transactions)
|
||||
* block get_block(hash)
|
||||
* height get_block_height(hash)
|
||||
* header get_block_header(hash)
|
||||
* block get_block_from_height(height)
|
||||
* size_t get_block_size(height)
|
||||
* difficulty get_block_cumulative_difficulty(height)
|
||||
* uint64_t get_block_already_generated_coins(height)
|
||||
* uint64_t get_block_timestamp(height)
|
||||
* uint64_t get_top_block_timestamp()
|
||||
* hash get_block_hash_from_height(height)
|
||||
* blocks get_blocks_range(height1, height2)
|
||||
* hashes get_hashes_range(height1, height2)
|
||||
* hash top_block_hash()
|
||||
* block get_top_block()
|
||||
* height height()
|
||||
* void pop_block(block&, tx_list&)
|
||||
*
|
||||
* Transactions:
|
||||
* bool tx_exists(hash)
|
||||
* uint64_t get_tx_unlock_time(hash)
|
||||
* tx get_tx(hash)
|
||||
* uint64_t get_tx_count()
|
||||
* tx_list get_tx_list(hash_list)
|
||||
* height get_tx_block_height(hash)
|
||||
*
|
||||
* Outputs:
|
||||
* index get_random_output(amount)
|
||||
* uint64_t get_num_outputs(amount)
|
||||
* pub_key get_output_key(amount, index)
|
||||
* tx_out get_output(tx_hash, index)
|
||||
* hash,index get_output_tx_and_index_from_global(index)
|
||||
* hash,index get_output_tx_and_index(amount, index)
|
||||
* vec<uint64> get_tx_output_indices(tx_hash)
|
||||
*
|
||||
*
|
||||
* Spent Output Key Images:
|
||||
* bool has_key_image(key_image)
|
||||
*
|
||||
* Exceptions:
|
||||
* DB_ERROR -- generic
|
||||
* DB_OPEN_FAILURE
|
||||
* DB_CREATE_FAILURE
|
||||
* DB_SYNC_FAILURE
|
||||
* BLOCK_DNE
|
||||
* BLOCK_PARENT_DNE
|
||||
* BLOCK_EXISTS
|
||||
* BLOCK_INVALID -- considering making this multiple errors
|
||||
* TX_DNE
|
||||
* TX_EXISTS
|
||||
* OUTPUT_DNE
|
||||
* OUTPUT_EXISTS
|
||||
* KEY_IMAGE_EXISTS
|
||||
*/
|
||||
|
||||
namespace cryptonote
|
||||
{
|
||||
|
||||
// typedef for convenience
|
||||
typedef std::pair<crypto::hash, uint64_t> tx_out_index;
|
||||
|
||||
/***********************************
|
||||
* Exception Definitions
|
||||
***********************************/
|
||||
class DB_EXCEPTION : public std::exception
|
||||
{
|
||||
private:
|
||||
std::string m;
|
||||
|
||||
protected:
|
||||
DB_EXCEPTION(const char *s) : m(s) { }
|
||||
|
||||
public:
|
||||
virtual ~DB_EXCEPTION() { }
|
||||
|
||||
const char* what() const throw()
|
||||
{
|
||||
return m.c_str();
|
||||
}
|
||||
};
|
||||
|
||||
class DB_ERROR : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
DB_ERROR() : DB_EXCEPTION("Generic DB Error") { }
|
||||
DB_ERROR(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
class DB_OPEN_FAILURE : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
DB_OPEN_FAILURE() : DB_EXCEPTION("Failed to open the db") { }
|
||||
DB_OPEN_FAILURE(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
class DB_CREATE_FAILURE : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
DB_CREATE_FAILURE() : DB_EXCEPTION("Failed to create the db") { }
|
||||
DB_CREATE_FAILURE(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
class DB_SYNC_FAILURE : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
DB_SYNC_FAILURE() : DB_EXCEPTION("Failed to sync the db") { }
|
||||
DB_SYNC_FAILURE(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
class BLOCK_DNE : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
BLOCK_DNE() : DB_EXCEPTION("The block requested does not exist") { }
|
||||
BLOCK_DNE(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
class BLOCK_PARENT_DNE : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
BLOCK_PARENT_DNE() : DB_EXCEPTION("The parent of the block does not exist") { }
|
||||
BLOCK_PARENT_DNE(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
class BLOCK_EXISTS : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
BLOCK_EXISTS() : DB_EXCEPTION("The block to be added already exists!") { }
|
||||
BLOCK_EXISTS(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
class BLOCK_INVALID : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
BLOCK_INVALID() : DB_EXCEPTION("The block to be added did not pass validation!") { }
|
||||
BLOCK_INVALID(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
class TX_DNE : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
TX_DNE() : DB_EXCEPTION("The transaction requested does not exist") { }
|
||||
TX_DNE(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
class TX_EXISTS : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
TX_EXISTS() : DB_EXCEPTION("The transaction to be added already exists!") { }
|
||||
TX_EXISTS(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
class OUTPUT_DNE : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
OUTPUT_DNE() : DB_EXCEPTION("The output requested does not exist!") { }
|
||||
OUTPUT_DNE(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
class OUTPUT_EXISTS : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
OUTPUT_EXISTS() : DB_EXCEPTION("The output to be added already exists!") { }
|
||||
OUTPUT_EXISTS(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
class KEY_IMAGE_EXISTS : public DB_EXCEPTION
|
||||
{
|
||||
public:
|
||||
KEY_IMAGE_EXISTS() : DB_EXCEPTION("The spent key image to be added already exists!") { }
|
||||
KEY_IMAGE_EXISTS(const char* s) : DB_EXCEPTION(s) { }
|
||||
};
|
||||
|
||||
/***********************************
|
||||
* End of Exception Definitions
|
||||
***********************************/
|
||||
|
||||
|
||||
class BlockchainDB
|
||||
{
|
||||
private:
|
||||
/*********************************************************************
|
||||
* private virtual members
|
||||
*********************************************************************/
|
||||
|
||||
// tells the subclass to add the block and metadata to storage
|
||||
virtual void add_block( const block& blk
|
||||
, const size_t& block_size
|
||||
, const difficulty_type& cumulative_difficulty
|
||||
, const uint64_t& coins_generated
|
||||
, const crypto::hash& blk_hash
|
||||
) = 0;
|
||||
|
||||
// tells the subclass to remove data about the top block
|
||||
virtual void remove_block() = 0;
|
||||
|
||||
// tells the subclass to store the transaction and its metadata
|
||||
virtual void add_transaction_data(const crypto::hash& blk_hash, const transaction& tx, const crypto::hash& tx_hash) = 0;
|
||||
|
||||
// tells the subclass to remove data about a transaction
|
||||
virtual void remove_transaction_data(const crypto::hash& tx_hash, const transaction& tx) = 0;
|
||||
|
||||
// tells the subclass to store an output
|
||||
virtual void add_output(const crypto::hash& tx_hash, const tx_out& tx_output, const uint64_t& local_index) = 0;
|
||||
|
||||
// tells the subclass to remove an output
|
||||
virtual void remove_output(const tx_out& tx_output) = 0;
|
||||
|
||||
// tells the subclass to store a spent key
|
||||
virtual void add_spent_key(const crypto::key_image& k_image) = 0;
|
||||
|
||||
// tells the subclass to remove a spent key
|
||||
virtual void remove_spent_key(const crypto::key_image& k_image) = 0;
|
||||
|
||||
|
||||
/*********************************************************************
|
||||
* private concrete members
|
||||
*********************************************************************/
|
||||
// private version of pop_block, for undoing if an add_block goes tits up
|
||||
void pop_block();
|
||||
|
||||
// helper function for add_transactions, to add each individual tx
|
||||
void add_transaction(const crypto::hash& blk_hash, const transaction& tx, const crypto::hash* tx_hash_ptr = NULL);
|
||||
|
||||
// helper function to remove transaction from blockchain
|
||||
void remove_transaction(const crypto::hash& tx_hash);
|
||||
|
||||
uint64_t num_calls = 0;
|
||||
uint64_t time_blk_hash = 0;
|
||||
uint64_t time_add_block1 = 0;
|
||||
uint64_t time_add_transaction = 0;
|
||||
|
||||
|
||||
protected:
|
||||
|
||||
mutable uint64_t time_tx_exists = 0;
|
||||
uint64_t time_commit1 = 0;
|
||||
|
||||
|
||||
public:
|
||||
|
||||
// virtual dtor
|
||||
virtual ~BlockchainDB() { };
|
||||
|
||||
// reset profiling stats
|
||||
void reset_stats();
|
||||
|
||||
// show profiling stats
|
||||
void show_stats();
|
||||
|
||||
// open the db at location <filename>, or create it if there isn't one.
|
||||
virtual void open(const std::string& filename) = 0;
|
||||
|
||||
// make sure implementation has a create function as well
|
||||
virtual void create(const std::string& filename) = 0;
|
||||
|
||||
// close and sync the db
|
||||
virtual void close() = 0;
|
||||
|
||||
// sync the db
|
||||
virtual void sync() = 0;
|
||||
|
||||
// reset the db -- USE WITH CARE
|
||||
virtual void reset() = 0;
|
||||
|
||||
// get all files used by this db (if any)
|
||||
virtual std::vector<std::string> get_filenames() const = 0;
|
||||
|
||||
|
||||
// FIXME: these are just for functionality mocking, need to implement
|
||||
// RAII-friendly and multi-read one-write friendly locking mechanism
|
||||
//
|
||||
// acquire db lock
|
||||
virtual bool lock() = 0;
|
||||
|
||||
// release db lock
|
||||
virtual void unlock() = 0;
|
||||
|
||||
virtual void batch_start() = 0;
|
||||
virtual void batch_stop() = 0;
|
||||
virtual void set_batch_transactions(bool) = 0;
|
||||
|
||||
// adds a block with the given metadata to the top of the blockchain, returns the new height
|
||||
// NOTE: subclass implementations of this (or the functions it calls) need
|
||||
// to handle undoing any partially-added blocks in the event of a failure.
|
||||
virtual uint64_t add_block( const block& blk
|
||||
, const size_t& block_size
|
||||
, const difficulty_type& cumulative_difficulty
|
||||
, const uint64_t& coins_generated
|
||||
, const std::vector<transaction>& txs
|
||||
);
|
||||
|
||||
// return true if a block with hash <h> exists in the blockchain
|
||||
virtual bool block_exists(const crypto::hash& h) const = 0;
|
||||
|
||||
// return block with hash <h>
|
||||
virtual block get_block(const crypto::hash& h) const = 0;
|
||||
|
||||
// return the height of the block with hash <h> on the blockchain,
|
||||
// throw if it doesn't exist
|
||||
virtual uint64_t get_block_height(const crypto::hash& h) const = 0;
|
||||
|
||||
// return header for block with hash <h>
|
||||
virtual block_header get_block_header(const crypto::hash& h) const = 0;
|
||||
|
||||
// return block at height <height>
|
||||
virtual block get_block_from_height(const uint64_t& height) const = 0;
|
||||
|
||||
// return timestamp of block at height <height>
|
||||
virtual uint64_t get_block_timestamp(const uint64_t& height) const = 0;
|
||||
|
||||
// return timestamp of most recent block
|
||||
virtual uint64_t get_top_block_timestamp() const = 0;
|
||||
|
||||
// return block size of block at height <height>
|
||||
virtual size_t get_block_size(const uint64_t& height) const = 0;
|
||||
|
||||
// return cumulative difficulty up to and including block at height <height>
|
||||
virtual difficulty_type get_block_cumulative_difficulty(const uint64_t& height) const = 0;
|
||||
|
||||
// return difficulty of block at height <height>
|
||||
virtual difficulty_type get_block_difficulty(const uint64_t& height) const = 0;
|
||||
|
||||
// return number of coins generated up to and including block at height <height>
|
||||
virtual uint64_t get_block_already_generated_coins(const uint64_t& height) const = 0;
|
||||
|
||||
// return hash of block at height <height>
|
||||
virtual crypto::hash get_block_hash_from_height(const uint64_t& height) const = 0;
|
||||
|
||||
// return vector of blocks in range <h1,h2> of height (inclusively)
|
||||
virtual std::vector<block> get_blocks_range(const uint64_t& h1, const uint64_t& h2) const = 0;
|
||||
|
||||
// return vector of block hashes in range <h1, h2> of height (inclusively)
|
||||
virtual std::vector<crypto::hash> get_hashes_range(const uint64_t& h1, const uint64_t& h2) const = 0;
|
||||
|
||||
// return the hash of the top block on the chain
|
||||
virtual crypto::hash top_block_hash() const = 0;
|
||||
|
||||
// return the block at the top of the blockchain
|
||||
virtual block get_top_block() const = 0;
|
||||
|
||||
// return the height of the chain
|
||||
virtual uint64_t height() const = 0;
|
||||
|
||||
// pops the top block off the blockchain.
|
||||
// Returns by reference the popped block and its associated transactions
|
||||
//
|
||||
// IMPORTANT:
|
||||
// When a block is popped, the transactions associated with it need to be
|
||||
// removed, as well as outputs and spent key images associated with
|
||||
// those transactions.
|
||||
virtual void pop_block(block& blk, std::vector<transaction>& txs);
|
||||
|
||||
|
||||
// return true if a transaction with hash <h> exists
|
||||
virtual bool tx_exists(const crypto::hash& h) const = 0;
|
||||
|
||||
// return unlock time of tx with hash <h>
|
||||
virtual uint64_t get_tx_unlock_time(const crypto::hash& h) const = 0;
|
||||
|
||||
// return tx with hash <h>
|
||||
// throw if no such tx exists
|
||||
virtual transaction get_tx(const crypto::hash& h) const = 0;
|
||||
|
||||
// returns the total number of transactions in all blocks
|
||||
virtual uint64_t get_tx_count() const = 0;
|
||||
|
||||
// return list of tx with hashes <hlist>.
|
||||
// TODO: decide if a missing hash means return empty list
|
||||
// or just skip that hash
|
||||
virtual std::vector<transaction> get_tx_list(const std::vector<crypto::hash>& hlist) const = 0;
|
||||
|
||||
// returns height of block that contains transaction with hash <h>
|
||||
virtual uint64_t get_tx_block_height(const crypto::hash& h) const = 0;
|
||||
|
||||
// return global output index of a random output of amount <amount>
|
||||
virtual uint64_t get_random_output(const uint64_t& amount) const = 0;
|
||||
|
||||
// returns the total number of outputs of amount <amount>
|
||||
virtual uint64_t get_num_outputs(const uint64_t& amount) const = 0;
|
||||
|
||||
// return public key for output with global output amount <amount> and index <index>
|
||||
virtual crypto::public_key get_output_key(const uint64_t& amount, const uint64_t& index) const = 0;
|
||||
|
||||
// returns the output indexed by <index> in the transaction with hash <h>
|
||||
virtual tx_out get_output(const crypto::hash& h, const uint64_t& index) const = 0;
|
||||
|
||||
// returns the tx hash associated with an output, referenced by global output index
|
||||
virtual tx_out_index get_output_tx_and_index_from_global(const uint64_t& index) const = 0;
|
||||
|
||||
// returns the transaction-local reference for the output with <amount> at <index>
|
||||
// return type is pair of tx hash and index
|
||||
virtual tx_out_index get_output_tx_and_index(const uint64_t& amount, const uint64_t& index) const = 0;
|
||||
|
||||
// return a vector of indices corresponding to the global output index for
|
||||
// each output in the transaction with hash <h>
|
||||
virtual std::vector<uint64_t> get_tx_output_indices(const crypto::hash& h) const = 0;
|
||||
// return a vector of indices corresponding to the amount output index for
|
||||
// each output in the transaction with hash <h>
|
||||
virtual std::vector<uint64_t> get_tx_amount_output_indices(const crypto::hash& h) const = 0;
|
||||
|
||||
// returns true if key image <img> is present in spent key images storage
|
||||
virtual bool has_key_image(const crypto::key_image& img) const = 0;
|
||||
|
||||
}; // class BlockchainDB
|
||||
|
||||
|
||||
} // namespace cryptonote
|
||||
|
||||
#endif // BLOCKCHAIN_DB_H
|
||||
Loading…
Add table
Add a link
Reference in a new issue