Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Avoid nullptr dereference when constructing Blockchain and tx_memory_pool #8033

Closed
wants to merge 1 commit into from
Closed

Avoid nullptr dereference when constructing Blockchain and tx_memory_pool #8033

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions src/blockchain_utilities/blockchain_ancestry.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
#include "cryptonote_core/cryptonote_core.h"
#include "cryptonote_core/blockchain.h"
#include "blockchain_db/blockchain_db.h"
#include "blockchain_and_pool.h"
#include "version.h"

#undef MONERO_DEFAULT_LOG_CATEGORY
Expand Down Expand Up @@ -449,9 +450,7 @@ int main(int argc, char* argv[])
// because unlike blockchain_storage constructor, which takes a pointer to
// tx_memory_pool, Blockchain's constructor takes tx_memory_pool object.
LOG_PRINT_L0("Initializing source blockchain (BlockchainDB)");
std::unique_ptr<Blockchain> core_storage;
tx_memory_pool m_mempool(*core_storage);
core_storage.reset(new Blockchain(m_mempool));
std::unique_ptr<BlockchainAndPool> core_storage = std::make_unique<BlockchainAndPool>();
BlockchainDB *db = new_db();
if (db == NULL)
{
Expand All @@ -472,7 +471,7 @@ int main(int argc, char* argv[])
LOG_PRINT_L0("Error opening database: " << e.what());
return 1;
}
r = core_storage->init(db, net_type);
r = core_storage->blockchain.init(db, net_type);

CHECK_AND_ASSERT_MES(r, 1, "Failed to initialize source blockchain storage");
LOG_PRINT_L0("Source blockchain storage initialized OK");
Expand Down Expand Up @@ -716,7 +715,7 @@ int main(int argc, char* argv[])
}

done:
core_storage->deinit();
core_storage->blockchain.deinit();

if (opt_show_cache_stats)
MINFO("cache: txes " << std::to_string(cached_txes*100./total_txes)
Expand Down
44 changes: 44 additions & 0 deletions src/blockchain_utilities/blockchain_and_pool.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Copyright (c) 2014-2020, 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.

#pragma once

#include "cryptonote_core/blockchain.h"
#include "cryptonote_core/tx_pool.h"

struct BlockchainAndPool {
cryptonote::Blockchain blockchain;
cryptonote::tx_memory_pool tx_pool;

BlockchainAndPool() : blockchain(tx_pool), tx_pool(blockchain) {}
};
Comment on lines +39 to +44
Copy link
Contributor

@UkoeHB UkoeHB Oct 31, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems strange to initialize an object with an uninitialized other object. Would this pattern be more intuitive?

struct BlockchainAndPool {
  cryptonote::Blockchain blockchain;
  cryptonote::tx_memory_pool tx_pool;

  BlockchainAndPool() : blockchain(), tx_pool(blockchain) {
    blockchain.set_tx_pool(tx_pool);
  }
};

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was following how cryptonode::core does it here:
https://github.com/monero-project/monero/blob/528cd729687fcc73e2c082225af203d5f67b3eb6/src/cryptonote_core/cryptonote_core.cpp#L228

@moneromooo-monero has proposed this pattern on IRC/Matrix

Maybe a problem with using a setter would be that if the setter is not called the object would be in an invalid state.
Another reason is that Blockchain and tx_memory_pool hold a reference to each other and those references need to be initialized in the constructor.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. The original design is dubious but I guess yours is the best solution without more intrusive changes.

15 changes: 4 additions & 11 deletions src/blockchain_utilities/blockchain_depth.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
#include "cryptonote_core/cryptonote_core.h"
#include "cryptonote_core/blockchain.h"
#include "blockchain_db/blockchain_db.h"
#include "blockchain_and_pool.h"
#include "version.h"

#undef MONERO_DEFAULT_LOG_CATEGORY
Expand Down Expand Up @@ -129,16 +130,8 @@ int main(int argc, char* argv[])
// Use Blockchain instead of lower-level BlockchainDB for two reasons:
// 1. Blockchain has the init() method for easy setup
// 2. exporter needs to use get_current_blockchain_height(), get_block_id_by_height(), get_block_by_hash()
//
// cannot match blockchain_storage setup above with just one line,
// e.g.
// Blockchain* core_storage = new Blockchain(NULL);
// because unlike blockchain_storage constructor, which takes a pointer to
// tx_memory_pool, Blockchain's constructor takes tx_memory_pool object.
LOG_PRINT_L0("Initializing source blockchain (BlockchainDB)");
std::unique_ptr<Blockchain> core_storage;
tx_memory_pool m_mempool(*core_storage);
core_storage.reset(new Blockchain(m_mempool));
std::unique_ptr<BlockchainAndPool> core_storage = std::make_unique<BlockchainAndPool>();
BlockchainDB *db = new_db();
if (db == NULL)
{
Expand All @@ -159,7 +152,7 @@ int main(int argc, char* argv[])
LOG_PRINT_L0("Error opening database: " << e.what());
return 1;
}
r = core_storage->init(db, net_type);
r = core_storage->blockchain.init(db, net_type);

CHECK_AND_ASSERT_MES(r, 1, "Failed to initialize source blockchain storage");
LOG_PRINT_L0("Source blockchain storage initialized OK");
Expand Down Expand Up @@ -327,7 +320,7 @@ int main(int argc, char* argv[])
LOG_PRINT_L0("Average min depth for " << start_txids.size() << " transaction(s): " << cumulative_depth/(float)depths.size());
LOG_PRINT_L0("Median min depth for " << start_txids.size() << " transaction(s): " << epee::misc_utils::median(depths));

core_storage->deinit();
core_storage->blockchain.deinit();
return 0;

CATCH_ENTRY("Depth query error", 1);
Expand Down
19 changes: 6 additions & 13 deletions src/blockchain_utilities/blockchain_export.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@

#include "bootstrap_file.h"
#include "blocksdat_file.h"
#include "blockchain_and_pool.h"
#include "common/command_line.h"
#include "cryptonote_core/tx_pool.h"
#include "cryptonote_core/cryptonote_core.h"
Expand Down Expand Up @@ -129,16 +130,8 @@ int main(int argc, char* argv[])
// Use Blockchain instead of lower-level BlockchainDB for two reasons:
// 1. Blockchain has the init() method for easy setup
// 2. exporter needs to use get_current_blockchain_height(), get_block_id_by_height(), get_block_by_hash()
//
// cannot match blockchain_storage setup above with just one line,
// e.g.
// Blockchain* core_storage = new Blockchain(NULL);
// because unlike blockchain_storage constructor, which takes a pointer to
// tx_memory_pool, Blockchain's constructor takes tx_memory_pool object.
LOG_PRINT_L0("Initializing source blockchain (BlockchainDB)");
Blockchain* core_storage = NULL;
tx_memory_pool m_mempool(*core_storage);
core_storage = new Blockchain(m_mempool);
std::unique_ptr<BlockchainAndPool> core_storage = std::make_unique<BlockchainAndPool>();

BlockchainDB* db = new_db();
if (db == NULL)
Expand All @@ -162,9 +155,9 @@ int main(int argc, char* argv[])
LOG_PRINT_L0("Error opening database: " << e.what());
return 1;
}
r = core_storage->init(db, opt_testnet ? cryptonote::TESTNET : opt_stagenet ? cryptonote::STAGENET : cryptonote::MAINNET);
r = core_storage->blockchain.init(db, opt_testnet ? cryptonote::TESTNET : opt_stagenet ? cryptonote::STAGENET : cryptonote::MAINNET);

if (core_storage->get_blockchain_pruning_seed() && !opt_blocks_dat)
if (core_storage->blockchain.get_blockchain_pruning_seed() && !opt_blocks_dat)
{
LOG_PRINT_L0("Blockchain is pruned, cannot export");
return 1;
Expand All @@ -177,12 +170,12 @@ int main(int argc, char* argv[])
if (opt_blocks_dat)
{
BlocksdatFile blocksdat;
r = blocksdat.store_blockchain_raw(core_storage, NULL, output_file_path, block_stop);
r = blocksdat.store_blockchain_raw(&core_storage->blockchain, NULL, output_file_path, block_stop);
}
else
{
BootstrapFile bootstrap;
r = bootstrap.store_blockchain_raw(core_storage, NULL, output_file_path, block_start, block_stop);
r = bootstrap.store_blockchain_raw(&core_storage->blockchain, NULL, output_file_path, block_start, block_stop);
}
CHECK_AND_ASSERT_MES(r, 1, "Failed to export blockchain raw data");
LOG_PRINT_L0("Blockchain raw data exported OK");
Expand Down
24 changes: 9 additions & 15 deletions src/blockchain_utilities/blockchain_prune.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
#include <boost/system/error_code.hpp>
#include <boost/filesystem.hpp>
#include "common/command_line.h"
#include "blockchain_and_pool.h"
#include "common/pruning.h"
#include "cryptonote_core/cryptonote_core.h"
#include "cryptonote_core/blockchain.h"
Expand Down Expand Up @@ -516,22 +517,15 @@ int main(int argc, char* argv[])
// Use Blockchain instead of lower-level BlockchainDB for two reasons:
// 1. Blockchain has the init() method for easy setup
// 2. exporter needs to use get_current_blockchain_height(), get_block_id_by_height(), get_block_by_hash()
//
// cannot match blockchain_storage setup above with just one line,
// e.g.
// Blockchain* core_storage = new Blockchain(NULL);
// because unlike blockchain_storage constructor, which takes a pointer to
// tx_memory_pool, Blockchain's constructor takes tx_memory_pool object.
MINFO("Initializing source blockchain (BlockchainDB)");
std::array<std::unique_ptr<Blockchain>, 2> core_storage;
Blockchain *blockchain = NULL;
tx_memory_pool m_mempool(*blockchain);
std::array<std::unique_ptr<BlockchainAndPool>, 2> core_storage{
std::make_unique<BlockchainAndPool>(),
std::make_unique<BlockchainAndPool>()};

boost::filesystem::path paths[2];
bool already_pruned = false;
for (size_t n = 0; n < core_storage.size(); ++n)
{
core_storage[n].reset(new Blockchain(m_mempool));

BlockchainDB* db = new_db();
if (db == NULL)
{
Expand Down Expand Up @@ -576,12 +570,12 @@ int main(int argc, char* argv[])
MERROR("Error opening database: " << e.what());
return 1;
}
r = core_storage[n]->init(db, net_type);
r = core_storage[n]->blockchain.init(db, net_type);

std::string source_dest = n == 0 ? "source" : "pruned";
CHECK_AND_ASSERT_MES(r, 1, "Failed to initialize " << source_dest << " blockchain storage");
MINFO(source_dest << " blockchain storage initialized OK");
if (n == 0 && core_storage[0]->get_blockchain_pruning_seed())
if (n == 0 && core_storage[0]->blockchain.get_blockchain_pruning_seed())
{
if (!opt_copy_pruned_database)
{
Expand All @@ -591,9 +585,9 @@ int main(int argc, char* argv[])
already_pruned = true;
}
}
core_storage[0]->deinit();
core_storage[0]->blockchain.deinit();
core_storage[0].reset(NULL);
core_storage[1]->deinit();
core_storage[1]->blockchain.deinit();
core_storage[1].reset(NULL);

MINFO("Pruning...");
Expand Down
10 changes: 5 additions & 5 deletions src/blockchain_utilities/blockchain_prune_known_spent_data.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
#include "cryptonote_core/cryptonote_core.h"
#include "cryptonote_core/blockchain.h"
#include "blockchain_db/blockchain_db.h"
#include "blockchain_and_pool.h"
#include "version.h"

#undef MONERO_DEFAULT_LOG_CATEGORY
Expand Down Expand Up @@ -160,9 +161,8 @@ int main(int argc, char* argv[])
const std::string input = command_line::get_arg(vm, arg_input);

LOG_PRINT_L0("Initializing source blockchain (BlockchainDB)");
std::unique_ptr<Blockchain> core_storage;
tx_memory_pool m_mempool(*core_storage);
core_storage.reset(new Blockchain(m_mempool));
std::unique_ptr<BlockchainAndPool> core_storage = std::make_unique<BlockchainAndPool>();

BlockchainDB *db = new_db();
if (db == NULL)
{
Expand All @@ -182,7 +182,7 @@ int main(int argc, char* argv[])
LOG_PRINT_L0("Error opening database: " << e.what());
return 1;
}
r = core_storage->init(db, net_type);
r = core_storage->blockchain.init(db, net_type);

CHECK_AND_ASSERT_MES(r, 1, "Failed to initialize source blockchain storage");
LOG_PRINT_L0("Source blockchain storage initialized OK");
Expand Down Expand Up @@ -280,7 +280,7 @@ int main(int argc, char* argv[])
MINFO("Prunable outputs: " << num_prunable_outputs);

LOG_PRINT_L0("Blockchain known spent data pruned OK");
core_storage->deinit();
core_storage->blockchain.deinit();
return 0;

CATCH_ENTRY("Error", 1);
Expand Down
10 changes: 5 additions & 5 deletions src/blockchain_utilities/blockchain_stats.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
#include "common/command_line.h"
#include "common/varint.h"
#include "cryptonote_basic/cryptonote_boost_serialization.h"
#include "blockchain_and_pool.h"
#include "cryptonote_core/tx_pool.h"
#include "cryptonote_core/cryptonote_core.h"
#include "cryptonote_core/blockchain.h"
Expand Down Expand Up @@ -132,9 +133,8 @@ int main(int argc, char* argv[])
bool do_diff = command_line::get_arg(vm, arg_diff);

LOG_PRINT_L0("Initializing source blockchain (BlockchainDB)");
std::unique_ptr<Blockchain> core_storage;
tx_memory_pool m_mempool(*core_storage);
core_storage.reset(new Blockchain(m_mempool));
std::unique_ptr<BlockchainAndPool> core_storage = std::make_unique<BlockchainAndPool>();

BlockchainDB *db = new_db();
if (db == NULL)
{
Expand All @@ -154,7 +154,7 @@ int main(int argc, char* argv[])
LOG_PRINT_L0("Error opening database: " << e.what());
return 1;
}
r = core_storage->init(db, net_type);
r = core_storage->blockchain.init(db, net_type);

CHECK_AND_ASSERT_MES(r, 1, "Failed to initialize source blockchain storage");
LOG_PRINT_L0("Source blockchain storage initialized OK");
Expand Down Expand Up @@ -372,7 +372,7 @@ plot 'stats.csv' index "DATA" using (timecolumn(1,"%Y-%m-%d")):4 with lines, ''
break;
}

core_storage->deinit();
core_storage->blockchain.deinit();
return 0;

CATCH_ENTRY("Stats reporting error", 1);
Expand Down
12 changes: 6 additions & 6 deletions src/blockchain_utilities/blockchain_usage.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
#include "cryptonote_core/cryptonote_core.h"
#include "cryptonote_core/blockchain.h"
#include "blockchain_db/blockchain_db.h"
#include "blockchain_and_pool.h"
#include "version.h"

#undef MONERO_DEFAULT_LOG_CATEGORY
Expand Down Expand Up @@ -151,9 +152,8 @@ int main(int argc, char* argv[])
// tx_memory_pool, Blockchain's constructor takes tx_memory_pool object.
LOG_PRINT_L0("Initializing source blockchain (BlockchainDB)");
const std::string input = command_line::get_arg(vm, arg_input);
std::unique_ptr<Blockchain> core_storage;
tx_memory_pool m_mempool(*core_storage);
core_storage.reset(new Blockchain(m_mempool));
std::unique_ptr<BlockchainAndPool> core_storage = std::make_unique<BlockchainAndPool>();

BlockchainDB* db = new_db();
if (db == NULL)
{
Expand All @@ -174,7 +174,7 @@ int main(int argc, char* argv[])
LOG_PRINT_L0("Error opening database: " << e.what());
return 1;
}
r = core_storage->init(db, net_type);
r = core_storage->blockchain.init(db, net_type);

CHECK_AND_ASSERT_MES(r, 1, "Failed to initialize source blockchain storage");
LOG_PRINT_L0("Source blockchain storage initialized OK");
Expand All @@ -185,10 +185,10 @@ int main(int argc, char* argv[])
std::unordered_map<uint64_t,uint64_t> indices;

LOG_PRINT_L0("Reading blockchain from " << input);
core_storage->for_all_transactions([&](const crypto::hash &hash, const cryptonote::transaction &tx)->bool
core_storage->blockchain.for_all_transactions([&](const crypto::hash &hash, const cryptonote::transaction &tx)->bool
{
const bool coinbase = tx.vin.size() == 1 && tx.vin[0].type() == typeid(txin_gen);
const uint64_t height = core_storage->get_db().get_tx_block_height(hash);
const uint64_t height = core_storage->blockchain.get_db().get_tx_block_height(hash);

// create new outputs
for (const auto &out: tx.vout)
Expand Down