// 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. #include #include #include "common/command_line.h" #include "serialization/crypto.h" #include "cryptonote_core/tx_pool.h" #include "cryptonote_core/cryptonote_core.h" #include "cryptonote_core/blockchain.h" #include "blockchain_db/blockchain_db.h" #include "version.h" #undef MONERO_DEFAULT_LOG_CATEGORY #define MONERO_DEFAULT_LOG_CATEGORY "bcutil" namespace po = boost::program_options; using namespace epee; using namespace cryptonote; static std::map load_outputs(const std::string &filename) { std::map outputs; uint64_t amount = std::numeric_limits::max(); FILE *f; f = fopen(filename.c_str(), "r"); if (!f) { MERROR("Failed to load outputs from " << filename << ": " << strerror(errno)); return {}; } while (1) { char s[256]; if (!fgets(s, sizeof(s), f)) break; if (feof(f)) break; const size_t len = strlen(s); if (len > 0 && s[len - 1] == '\n') s[len - 1] = 0; if (!s[0]) continue; uint64_t offset, num_offsets; if (sscanf(s, "@%" PRIu64, &amount) == 1) { continue; } if (amount == std::numeric_limits::max()) { MERROR("Bad format in " << filename); continue; } if (sscanf(s, "%" PRIu64 "*%" PRIu64, &offset, &num_offsets) == 2 && num_offsets < std::numeric_limits::max() - offset) { outputs[amount] += num_offsets; } else if (sscanf(s, "%" PRIu64, &offset) == 1) { outputs[amount] += 1; } else { MERROR("Bad format in " << filename); continue; } } fclose(f); return outputs; } int main(int argc, char* argv[]) { TRY_ENTRY(); epee::string_tools::set_module_name_and_folder(argv[0]); uint32_t log_level = 0; tools::on_startup(); po::options_description desc_cmd_only("Command line options"); po::options_description desc_cmd_sett("Command line options and settings options"); const command_line::arg_descriptor arg_log_level = {"log-level", "0-4 or categories", ""}; const command_line::arg_descriptor arg_verbose = {"verbose", "Verbose output", false}; const command_line::arg_descriptor arg_dry_run = {"dry-run", "Do not actually prune", false}; const command_line::arg_descriptor arg_input = {"input", "Path to the known spent outputs file"}; command_line::add_arg(desc_cmd_sett, cryptonote::arg_data_dir); command_line::add_arg(desc_cmd_sett, cryptonote::arg_testnet_on); command_line::add_arg(desc_cmd_sett, cryptonote::arg_stagenet_on); command_line::add_arg(desc_cmd_sett, arg_log_level); command_line::add_arg(desc_cmd_sett, arg_verbose); command_line::add_arg(desc_cmd_sett, arg_dry_run); command_line::add_arg(desc_cmd_sett, arg_input); command_line::add_arg(desc_cmd_only, command_line::arg_help); po::options_description desc_options("Allowed options"); desc_options.add(desc_cmd_only).add(desc_cmd_sett); po::variables_map vm; bool r = command_line::handle_error_helper(desc_options, [&]() { auto parser = po::command_line_parser(argc, argv).options(desc_options); po::store(parser.run(), vm); po::notify(vm); return true; }); if (! r) return 1; if (command_line::get_arg(vm, command_line::arg_help)) { std::cout << "Monero '" << MONERO_RELEASE_NAME << "' (v" << MONERO_VERSION_FULL << ")" << ENDL << ENDL; std::cout << desc_options << std::endl; return 1; } mlog_configure(mlog_get_default_log_path("monero-blockchain-prune-known-spent-data.log"), true); if (!command_line::is_arg_defaulted(vm, arg_log_level)) mlog_set_log(command_line::get_arg(vm, arg_log_level).c_str()); else mlog_set_log(std::string(std::to_string(log_level) + ",bcutil:INFO").c_str()); LOG_PRINT_L0("Starting..."); std::string opt_data_dir = command_line::get_arg(vm, cryptonote::arg_data_dir); bool opt_testnet = command_line::get_arg(vm, cryptonote::arg_testnet_on); bool opt_stagenet = command_line::get_arg(vm, cryptonote::arg_stagenet_on); network_type net_type = opt_testnet ? TESTNET : opt_stagenet ? STAGENET : MAINNET; bool opt_verbose = command_line::get_arg(vm, arg_verbose); bool opt_dry_run = command_line::get_arg(vm, arg_dry_run); const std::string input = command_line::get_arg(vm, arg_input); LOG_PRINT_L0("Initializing source blockchain (BlockchainDB)"); std::unique_ptr core_storage; tx_memory_pool m_mempool(*core_storage); core_storage.reset(new Blockchain(m_mempool)); BlockchainDB *db = new_db(); if (db == NULL) { LOG_ERROR("Failed to initialize a database"); throw std::runtime_error("Failed to initialize a database"); } const std::string filename = (boost::filesystem::path(opt_data_dir) / db->get_db_name()).string(); LOG_PRINT_L0("Loading blockchain from folder " << filename << " ..."); try { db->open(filename, 0); } catch (const std::exception& e) { LOG_PRINT_L0("Error opening database: " << e.what()); return 1; } r = core_storage->init(db, net_type); CHECK_AND_ASSERT_MES(r, 1, "Failed to initialize source blockchain storage"); LOG_PRINT_L0("Source blockchain storage initialized OK"); std::map known_spent_outputs; if (input.empty()) { std::map> outputs; LOG_PRINT_L0("Scanning for known spent data..."); db->for_all_transactions([&](const crypto::hash &txid, const cryptonote::transaction &tx){ const bool miner_tx = tx.vin.size() == 1 && tx.vin[0].type() == typeid(txin_gen); for (const auto &in: tx.vin) { if (in.type() != typeid(txin_to_key)) continue; const auto &txin = boost::get(in); if (txin.amount == 0) continue; outputs[txin.amount].second++; } for (const auto &out: tx.vout) { uint64_t amount = out.amount; if (miner_tx && tx.version >= 2) amount = 0; if (amount == 0) continue; if (out.target.type() != typeid(txout_to_key)) continue; outputs[amount].first++; } return true; }, true); for (const auto &i: outputs) { known_spent_outputs[i.first] = i.second.second; } } else { LOG_PRINT_L0("Loading known spent data..."); known_spent_outputs = load_outputs(input); } LOG_PRINT_L0("Pruning known spent data..."); bool stop_requested = false; tools::signal_handler::install([&stop_requested](int type) { stop_requested = true; }); db->batch_start(); size_t num_total_outputs = 0, num_prunable_outputs = 0, num_known_spent_outputs = 0, num_eligible_outputs = 0, num_eligible_known_spent_outputs = 0; for (auto i = known_spent_outputs.begin(); i != known_spent_outputs.end(); ++i) { uint64_t num_outputs = db->get_num_outputs(i->first); num_total_outputs += num_outputs; num_known_spent_outputs += i->second; if (i->first == 0 || is_valid_decomposed_amount(i->first)) { if (opt_verbose) MINFO("Ignoring output value " << i->first << ", with " << num_outputs << " outputs"); continue; } num_eligible_outputs += num_outputs; num_eligible_known_spent_outputs += i->second; if (opt_verbose) MINFO(i->first << ": " << i->second << "/" << num_outputs); if (num_outputs > i->second) continue; if (num_outputs && num_outputs < i->second) { MERROR("More outputs are spent than known for amount " << i->first << ", not touching"); continue; } if (opt_verbose) MINFO("Pruning data for " << num_outputs << " outputs"); if (!opt_dry_run) db->prune_outputs(i->first); num_prunable_outputs += i->second; } db->batch_stop(); MINFO("Total outputs: " << num_total_outputs); MINFO("Known spent outputs: " << num_known_spent_outputs); MINFO("Eligible outputs: " << num_eligible_outputs); MINFO("Eligible known spent outputs: " << num_eligible_known_spent_outputs); MINFO("Prunable outputs: " << num_prunable_outputs); LOG_PRINT_L0("Blockchain known spent data pruned OK"); core_storage->deinit(); return 0; CATCH_ENTRY("Error", 1); }