wallet2_basic: wallet cache size debugging utility

src/wallet/wallet2_basic/CMakeLists.txt

@@ -72,3 +72,15 @@ endif()
 
 install(FILES ${wallet2_basic_headers}
     DESTINATION include/wallet/wallet2_basic)
+
+monero_add_executable(wallet2_size_debug
+  wallet2_size_debug.cpp)
+
+target_link_libraries(wallet2_size_debug
+  PRIVATE
+    wallet2_basic)
+
+set_property(TARGET wallet2_size_debug
+	PROPERTY
+	OUTPUT_NAME "monero-wallet2-size-debug")
+install(TARGETS wallet2_size_debug DESTINATION bin)

src/wallet/wallet2_basic/wallet2_size_debug.cpp

@@ -0,0 +1,157 @@
+// Copyright (c) 2023, 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 <boost/filesystem.hpp>
+
+#include "common/command_line.h"
+#include "common/password.h"
+#include "common/util.h"
+#include "cryptonote_core/cryptonote_core.h"
+#include "file_io_utils.h"
+#include "serialization/binary_archive.h"
+#include "serialization/containers.h"
+#include "serialization/crypto.h"
+#include "serialization/pair.h"
+#include "serialization/string.h"
+#include "serialization/variant.h"
+#include "version.h"
+#include "wallet2_storage.h"
+
+using namespace epee;
+using namespace wallet2_basic;
+
+namespace po = boost::program_options;
+
+#undef MONERO_DEFAULT_LOG_CATEGORY
+#define MONERO_DEFAULT_LOG_CATEGORY "walletutil"
+
+#define DEBUG_CACHE_FIELD_SIZE(name) \
+    { \
+        std::stringstream ss; \
+        binary_archive<true> ar(ss); \
+        CHECK_AND_ASSERT_THROW_MES(::serialization::serialize(ar, c.name), "Failed to serialize cache field " #name); \
+        const size_t sersize = ss.str().size(); \
+        MINFO("Wallet field " #name " takes up " << sersize << " bytes."); \
+    } \
+
+int main(int argc, char* argv[])
+{
+    epee::string_tools::set_module_name_and_folder(argv[0]);
+
+    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, true> arg_wallet_file  = {"wallet-file", "path to wallet file"};
+
+    command_line::add_arg(desc_cmd_sett, arg_log_level);
+    command_line::add_arg(desc_cmd_sett, arg_wallet_file);
+    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::positional_options_description positional_options;
+    positional_options.add(arg_wallet_file.name, 1);
+
+    po::variables_map vm;
+    bool r = command_line::handle_error_helper(desc_options, [&]()
+    {
+        auto parser = po::command_line_parser(argc, argv).options(desc_options).positional(positional_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-wallet2-size-debug.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) + ",walletutil:INFO").c_str());
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+    std::string cache_blob;
+    CHECK_AND_ASSERT_THROW_MES(file_io_utils::load_file_to_string(command_line::get_arg(vm, arg_wallet_file), cache_blob),
+        "Could not read from file " << command_line::get_arg(vm, arg_wallet_file));
+
+    const auto pwd_container = tools::password_container::prompt(false, "Enter wallet password");
+
+    cache c = cache::load_from_memory(cache_blob, pwd_container->password(), {});
+
+    DEBUG_CACHE_FIELD_SIZE(m_blockchain)
+    DEBUG_CACHE_FIELD_SIZE(m_transfers)
+    DEBUG_CACHE_FIELD_SIZE(m_account_public_address)
+    DEBUG_CACHE_FIELD_SIZE(m_key_images)
+    DEBUG_CACHE_FIELD_SIZE(m_unconfirmed_txs)
+    DEBUG_CACHE_FIELD_SIZE(m_payments)
+    DEBUG_CACHE_FIELD_SIZE(m_tx_keys)
+    DEBUG_CACHE_FIELD_SIZE(m_confirmed_txs)
+    DEBUG_CACHE_FIELD_SIZE(m_tx_notes)
+    DEBUG_CACHE_FIELD_SIZE(m_unconfirmed_payments)
+    DEBUG_CACHE_FIELD_SIZE(m_pub_keys)
+    DEBUG_CACHE_FIELD_SIZE(m_address_book)
+    DEBUG_CACHE_FIELD_SIZE(m_scanned_pool_txs[0])
+    DEBUG_CACHE_FIELD_SIZE(m_scanned_pool_txs[1])
+    DEBUG_CACHE_FIELD_SIZE(m_subaddresses)
+    DEBUG_CACHE_FIELD_SIZE(m_subaddress_labels)
+    DEBUG_CACHE_FIELD_SIZE(m_additional_tx_keys)
+    DEBUG_CACHE_FIELD_SIZE(m_attributes)
+    DEBUG_CACHE_FIELD_SIZE(m_account_tags)
+    DEBUG_CACHE_FIELD_SIZE(m_ring_history_saved)
+    DEBUG_CACHE_FIELD_SIZE(m_last_block_reward)
+    DEBUG_CACHE_FIELD_SIZE(m_tx_device)
+    DEBUG_CACHE_FIELD_SIZE(m_device_last_key_image_sync)
+    DEBUG_CACHE_FIELD_SIZE(m_cold_key_images)
+    DEBUG_CACHE_FIELD_SIZE(m_has_ever_refreshed_from_node)
+
+    {
+        std::stringstream ss;
+        binary_archive<true> ar(ss);
+        CHECK_AND_ASSERT_THROW_MES(::serialization::serialize(ar, c), "Failed to serialize cache");
+        const size_t sersize = ss.str().size();
+        MINFO("Grand Total: " << sersize);
+    }
+
+    return 0;
+}