blockchain_prune.cpp File Reference

#include <array>
#include <lmdb.h>
#include <boost/algorithm/string.hpp>
#include "common/command_line.h"
#include "common/pruning.h"
#include "cryptonote_core/cryptonote_core.h"
#include "cryptonote_core/blockchain.h"
#include "blockchain_db/blockchain_db.h"
#include "blockchain_db/lmdb/db_lmdb.h"
#include "blockchain_db/db_types.h"
#include "version.h"

Include dependency graph for blockchain_prune.cpp:

Go to the source code of this file.

Macros
#define	ELECTRONEUM_DEFAULT_LOG_CATEGORY   "bcutil"
#define	MDB_val_set(var, val)

Functions
int	main (int argc, char *argv[])

Macro Definition Documentation

ELECTRONEUM_DEFAULT_LOG_CATEGORY

#define ELECTRONEUM_DEFAULT_LOG_CATEGORY   "bcutil"

Definition at line 42 of file blockchain_prune.cpp.

MDB_val_set

#define MDB_val_set	(		var,
			val )

Value:

MDB_val var = {sizeof(val), (void *)&val}

Definition at line 44 of file blockchain_prune.cpp.

Function Documentation

main()

int main	(	int	argc,
		char *	argv[] )

Definition at line 438 of file blockchain_prune.cpp.

{
  TRY_ENTRY();
 
  epee::string_tools::set_module_name_and_folder(argv[0]);
 
  std::string default_db_type = "lmdb";
 
  std::string available_dbs = cryptonote::blockchain_db_types(", ");
  available_dbs = "available: " + available_dbs;
 
  uint32_t log_level = 0;
 
  tools::on_startup();
 
  boost::filesystem::path output_file_path;
 
  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<std::string> arg_log_level  = {"log-level",  "0-4 or categories", ""};
  const command_line::arg_descriptor<std::string> arg_database = {
    "database", available_dbs.c_str(), default_db_type
  };
  const command_line::arg_descriptor<std::string> arg_db_sync_mode = {
    "db-sync-mode"
  , "Specify sync option, using format [safe|fast|fastest]:[nrecords_per_sync]."
  , "fast:1000"
  };
  const command_line::arg_descriptor<bool> arg_copy_pruned_database  = {"copy-pruned-database",  "Copy database anyway if already pruned"};
 
  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_database);
  command_line::add_arg(desc_cmd_sett, arg_db_sync_mode);
  command_line::add_arg(desc_cmd_sett, arg_copy_pruned_database);
  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 << "Electroneum '" << ELECTRONEUM_RELEASE_NAME << "' (v" << ELECTRONEUM_VERSION_FULL << ")" << ENDL << ENDL;
    std::cout << desc_options << std::endl;
    return 1;
  }
 
  mlog_configure(mlog_get_default_log_path("electroneum-blockchain-prune.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());
 
  MINFO("Starting...");
 
  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_copy_pruned_database = command_line::get_arg(vm, arg_copy_pruned_database);
  std::string data_dir = command_line::get_arg(vm, cryptonote::arg_data_dir);
  while (boost::ends_with(data_dir, "/") || boost::ends_with(data_dir, "\\"))
    data_dir.pop_back();
 
  std::string db_type = command_line::get_arg(vm, arg_database);
  if (!cryptonote::blockchain_valid_db_type(db_type))
  {
    MERROR("Invalid database type: " << db_type);
    return 1;
  }
  if (db_type != "lmdb")
  {
    MERROR("Unsupported database type: " << db_type << ". Only lmdb is supported");
    return 1;
  }
 
  std::string db_sync_mode = command_line::get_arg(vm, arg_db_sync_mode);
  uint64_t db_flags = 0;
  if (!parse_db_sync_mode(db_sync_mode, db_flags))
  {
    MERROR("Invalid db sync mode: " << db_sync_mode);
    return 1;
  }
 
  // If we wanted to use the memory pool, we would set up a fake_core.
 
  // 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);
  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(db_type);
    if (db == NULL)
    {
      MERROR("Attempted to use non-existent database type: " << db_type);
      throw std::runtime_error("Attempting to use non-existent database type");
    }
    MDEBUG("database: " << db_type);
 
    if (n == 1)
    {
      paths[1] = boost::filesystem::path(data_dir) / (db->get_db_name() + "-pruned");
      if (boost::filesystem::exists(paths[1]))
      {
        if (!boost::filesystem::is_directory(paths[1]))
        {
          MERROR("LMDB needs a directory path, but a file was passed: " << paths[1].string());
          return 1;
        }
      }
      else
      {
        if (!boost::filesystem::create_directories(paths[1]))
        {
          MERROR("Failed to create directory: " << paths[1].string());
          return 1;
        }
      }
      db_path = paths[1].string();
    }
    else
    {
      paths[0] = boost::filesystem::path(data_dir) / db->get_db_name();
    }
 
    MINFO("Loading blockchain from folder " << paths[n] << " ...");
 
    try
    {
      db->open(paths[n].string(), n == 0 ? DBF_RDONLY : 0);
    }
    catch (const std::exception& e)
    {
      MERROR("Error opening database: " << e.what());
      return 1;
    }
    r = core_storage[n]->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 (!opt_copy_pruned_database)
      {
        MERROR("Blockchain is already pruned, use --" << arg_copy_pruned_database.name << " to copy it anyway");
        return 1;
      }
      already_pruned = true;
    }
  }
  core_storage[0]->deinit();
  core_storage[0].reset(NULL);
  core_storage[1]->deinit();
  core_storage[1].reset(NULL);
 
  MINFO("Pruning...");
  MDB_env *env0 = NULL, *env1 = NULL;
  open(env0, paths[0], db_flags, true);
  open(env1, paths[1], db_flags, false);
  copy_table(env0, env1, "blocks", MDB_INTEGERKEY, MDB_APPEND);
  copy_table(env0, env1, "block_info", MDB_INTEGERKEY | MDB_DUPSORT| MDB_DUPFIXED, MDB_APPENDDUP, BlockchainLMDB::compare_uint64);
  copy_table(env0, env1, "block_heights", MDB_INTEGERKEY | MDB_DUPSORT| MDB_DUPFIXED, 0, BlockchainLMDB::compare_hash32);
  //copy_table(env0, env1, "txs", MDB_INTEGERKEY);
  copy_table(env0, env1, "txs_pruned", MDB_INTEGERKEY, MDB_APPEND);
  copy_table(env0, env1, "txs_prunable_hash", MDB_INTEGERKEY | MDB_DUPSORT | MDB_DUPFIXED, MDB_APPEND);
  // not copied: prunable, prunable_tip
  copy_table(env0, env1, "tx_indices", MDB_INTEGERKEY | MDB_DUPSORT | MDB_DUPFIXED, 0, BlockchainLMDB::compare_hash32);
  copy_table(env0, env1, "tx_outputs", MDB_INTEGERKEY, MDB_APPEND);
  copy_table(env0, env1, "output_txs", MDB_INTEGERKEY | MDB_DUPSORT | MDB_DUPFIXED, MDB_APPENDDUP, BlockchainLMDB::compare_uint64);
  copy_table(env0, env1, "output_amounts", MDB_INTEGERKEY | MDB_DUPSORT | MDB_DUPFIXED, MDB_APPENDDUP, BlockchainLMDB::compare_uint64);
  copy_table(env0, env1, "spent_keys", MDB_INTEGERKEY | MDB_DUPSORT | MDB_DUPFIXED, MDB_NODUPDATA, BlockchainLMDB::compare_hash32);
  copy_table(env0, env1, "txpool_meta", 0, MDB_NODUPDATA, BlockchainLMDB::compare_hash32);
  copy_table(env0, env1, "txpool_blob", 0, MDB_NODUPDATA, BlockchainLMDB::compare_hash32);
  copy_table(env0, env1, "hf_versions", MDB_INTEGERKEY, MDB_APPEND);
  copy_table(env0, env1, "properties", 0, 0, BlockchainLMDB::compare_string);
  if (already_pruned)
  {
    copy_table(env0, env1, "txs_prunable", MDB_INTEGERKEY, MDB_APPEND, BlockchainLMDB::compare_uint64);
    copy_table(env0, env1, "txs_prunable_tip", MDB_INTEGERKEY | MDB_DUPSORT | MDB_DUPFIXED, MDB_NODUPDATA, BlockchainLMDB::compare_uint64);
  }
  else
  {
    prune(env0, env1);
  }
  close(env1);
  close(env0);
 
  MINFO("Swapping databases, pre-pruning blockchain will be left in " << paths[0].string() + "-old and can be removed if desired");
  if (replace_file(paths[0].string(), paths[0].string() + "-old") || replace_file(paths[1].string(), paths[0].string()))
  {
    MERROR("Blockchain pruned OK, but renaming failed");
    return 1;
  }
 
  MINFO("Blockchain pruned OK");
  return 0;
 
  CATCH_ENTRY("Pruning error", 1);
}

Here is the call graph for this function: