Squashed 'libbitcoinkernel-sys/bitcoin/' changes from 1ea43dc365c..e9f14a07ed8

e9f14a07ed8 kernel: Add Purpose section to header documentation
8d1a7e84cfb kernel: Allowing reducing exports
9da2c0abcee kernel: Add pure kernel bitcoin-chainstate
33325ffbbe9 Kernel: Add functions for working with outpoints
9fd8f6576fb kernel: Add block hash type and block tree utility functions to C header
07428ce9f46 kernel: Add function to read block undo data from disk to C header
99ee229fda4 kernel: Add functions to read block from disk to C header
dcb8d495f2a kernel: Add function for copying block data to C header
d42211bd8a4 kernel: Add functions for the block validation state to C header
da8db18599c kernel: Add validation interface to C header
d5dcd00fa80 kernel: Add interrupt function to C header
523a29fc73f kernel: Add import blocks function to C header
e49b9881d90 kernel: Add chainstate load options for in-memory dbs in C header
d21cdb3b23d kernel: Add options for reindexing in C header
09afc607fa0 kernel: Add block validation to C header
7333864cb04 kernel: Add chainstate loading when instantiating a ChainstateManager
71509f3856d kernel: Add chainstate manager option for setting worker threads
69f4e9f05aa kernel: Add chainstate manager object to C header
06cba4a4653 kernel: Add notifications context option to C header
cd809dcae8f kernel: Add chain params context option to C header
cf9f9b18474 kernel: Add kernel library context object
REVERT: 1ea43dc365c kernel: Add Purpose section to header documentation
REVERT: 6fb86d14a3e kernel: Allowing reducing exports
REVERT: 0a3644da67e kernel: Add pure kernel bitcoin-chainstate
REVERT: bb7276e1a72 Kernel: Add functions for working with outpoints
REVERT: 5ef72e7c44b kernel: Add block hash type and block tree utility functions to C header
REVERT: 43b7b7b9d28 kernel: Add function to read block undo data from disk to C header
REVERT: 06a485c9ab1 kernel: Add functions to read block from disk to C header
REVERT: 69c184b44f9 kernel: Add function for copying block data to C header
REVERT: 0e973b20fcc kernel: Add functions for the block validation state to C header
REVERT: 6c2181dc52f kernel: Add validation interface to C header
REVERT: 4d8aa6b3fb1 kernel: Add interrupt function to C header
REVERT: 2ecd926cf30 kernel: Add import blocks function to C header
REVERT: efcfe2dfedf kernel: Add chainstate load options for in-memory dbs in C header
REVERT: bc6788ab7dc kernel: Add options for reindexing in C header
REVERT: e8f2f4fe225 kernel: Add block validation to C header
REVERT: ffd4ae233ee kernel: Add chainstate loading when instantiating a ChainstateManager
REVERT: 1167af89a8f kernel: Add chainstate manager option for setting worker threads
REVERT: b88637f6967 kernel: Add chainstate manager object to C header
REVERT: b4ff3ce0d34 kernel: Add notifications context option to C header
REVERT: e3d62c1ad32 kernel: Add chain params context option to C header
REVERT: a184a263df2 kernel: Add kernel library context object

git-subtree-dir: libbitcoinkernel-sys/bitcoin
git-subtree-split: e9f14a07ed8b8161840d739c24603539119ee5fd

Author: TheCharlatan

src/kernel/bitcoinkernel.cpp

@@ -273,7 +273,7 @@ struct LoggingConnection {
     }
 };
 
-class KernelNotifications : public kernel::Notifications
+class KernelNotifications final : public kernel::Notifications
 {
 private:
     btck_NotificationInterfaceCallbacks m_cbs;
@@ -345,7 +345,7 @@ class KernelValidationInterface final : public CValidationInterface
     {
         if (m_cbs.block_checked) {
             m_cbs.block_checked(m_cbs.user_data,
-                                btck_Block::ref(new std::shared_ptr<const CBlock>{block}),
+                                btck_Block::copy(btck_Block::ref(&block)),
                                 btck_BlockValidationState::ref(&stateIn));
         }
     }
@@ -354,7 +354,7 @@ class KernelValidationInterface final : public CValidationInterface
     {
         if (m_cbs.pow_valid_block) {
             m_cbs.pow_valid_block(m_cbs.user_data,
-                                  btck_Block::ref(new std::shared_ptr<const CBlock>{block}),
+                                  btck_Block::copy(btck_Block::ref(&block)),
                                   btck_BlockTreeEntry::ref(pindex));
         }
     }
@@ -363,7 +363,7 @@ class KernelValidationInterface final : public CValidationInterface
     {
         if (m_cbs.block_connected) {
             m_cbs.block_connected(m_cbs.user_data,
-                                  btck_Block::ref(new std::shared_ptr<const CBlock>{block}),
+                                  btck_Block::copy(btck_Block::ref(&block)),
                                   btck_BlockTreeEntry::ref(pindex));
         }
     }
@@ -372,7 +372,7 @@ class KernelValidationInterface final : public CValidationInterface
     {
         if (m_cbs.block_disconnected) {
             m_cbs.block_disconnected(m_cbs.user_data,
-                                     btck_Block::ref(new std::shared_ptr<const CBlock>{block}),
+                                     btck_Block::copy(btck_Block::ref(&block)),
                                      btck_BlockTreeEntry::ref(pindex));
         }
     }
@@ -402,8 +402,7 @@ class Context
 
     Context(const ContextOptions* options, bool& sane)
         : m_context{std::make_unique<kernel::Context>()},
-          m_interrupt{std::make_unique<util::SignalInterrupt>()},
-          m_signals{std::make_unique<ValidationSignals>(std::make_unique<ImmediateTaskRunner>())}
+          m_interrupt{std::make_unique<util::SignalInterrupt>()}
     {
         if (options) {
             LOCK(options->m_mutex);
@@ -414,6 +413,7 @@ class Context
                 m_notifications = options->m_notifications;
             }
             if (options->m_validation_interface) {
+                m_signals = std::make_unique<ValidationSignals>(std::make_unique<ImmediateTaskRunner>());
                 m_validation_interface = options->m_validation_interface;
                 m_signals->RegisterSharedValidationInterface(m_validation_interface);
             }
@@ -434,7 +434,9 @@ class Context
 
     ~Context()
     {
-        m_signals->UnregisterSharedValidationInterface(m_validation_interface);
+        if (m_signals) {
+            m_signals->UnregisterSharedValidationInterface(m_validation_interface);
+        }
     }
 };
 
@@ -757,19 +759,19 @@ btck_ChainParameters* btck_chain_parameters_create(const btck_ChainType chain_ty
 {
     switch (chain_type) {
     case btck_ChainType_MAINNET: {
-        return btck_ChainParameters::create(*CChainParams::Main());
+        return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::Main().release()));
     }
     case btck_ChainType_TESTNET: {
-        return btck_ChainParameters::create(*CChainParams::TestNet());
+        return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::TestNet().release()));
     }
     case btck_ChainType_TESTNET_4: {
-        return btck_ChainParameters::create(*CChainParams::TestNet4());
+        return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::TestNet4().release()));
     }
     case btck_ChainType_SIGNET: {
-        return btck_ChainParameters::create(*CChainParams::SigNet({}));
+        return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::SigNet({}).release()));
     }
     case btck_ChainType_REGTEST: {
-        return btck_ChainParameters::create(*CChainParams::RegTest({}));
+        return btck_ChainParameters::ref(const_cast<CChainParams*>(CChainParams::RegTest({}).release()));
     }
     }
     assert(false);
@@ -1022,7 +1024,6 @@ int btck_chainstate_manager_import_blocks(btck_ChainstateManager* chainman, cons
             }
         }
         node::ImportBlocks(*btck_ChainstateManager::get(chainman).m_chainman, import_files);
-        btck_ChainstateManager::get(chainman).m_chainman->ActiveChainstate().ForceFlushStateToDisk();
     } catch (const std::exception& e) {
         LogError("Failed to import blocks: %s", e.what());
         return -1;

src/kernel/bitcoinkernel.h

@@ -366,8 +366,12 @@ typedef struct {
 /**
  * A struct for holding the kernel notification callbacks. The user data
  * pointer may be used to point to user-defined structures to make processing
- * the notifications easier. Note that this makes it the user's responsibility
- * to ensure that the user_data outlives the kernel objects. Notifications can
+ * the notifications easier.
+ *
+ * If user_data_destroy is provided, the kernel will automatically call this
+ * callback to clean up user_data when the notification interface object is destroyed.
+ * If user_data_destroy is NULL, it is the user's responsibility to ensure that
+ * the user_data outlives the kernel objects. Notifications can
  * occur even as kernel objects are deleted, so care has to be taken to ensure
  * safe unwinding.
  */
@@ -873,7 +877,7 @@ BITCOINKERNEL_API btck_Context* BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_co
  * when reindexing, importing or processing blocks.
  *
  * @param[in] context  Non-null.
- * @return             0 if the interrupt was successfully, non-zero otherwise.
+ * @return             0 if the interrupt was successful, non-zero otherwise.
  */
 BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_context_interrupt(
     btck_Context* context) BITCOINKERNEL_ARG_NONNULL(1);
@@ -1014,7 +1018,7 @@ BITCOINKERNEL_API btck_ChainstateManager* BITCOINKERNEL_WARN_UNUSED_RESULT btck_
     const btck_ChainstateManagerOptions* chainstate_manager_options) BITCOINKERNEL_ARG_NONNULL(1);
 
 /**
- * @brief Triggers the start of a reindex if the option was previously set for
+ * @brief Triggers the start of a reindex if the wipe options were previously set for
  * the chainstate and block manager. Can also import an array of existing block
  * files selected by the user.
  *
@@ -1027,7 +1031,7 @@ BITCOINKERNEL_API btck_ChainstateManager* BITCOINKERNEL_WARN_UNUSED_RESULT btck_
 BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_import_blocks(
     btck_ChainstateManager* chainstate_manager,
     const char** block_file_paths_data, size_t* block_file_paths_lens,
-    size_t block_file_paths_data_len) BITCOINKERNEL_ARG_NONNULL(1, 2);
+    size_t block_file_paths_data_len) BITCOINKERNEL_ARG_NONNULL(1);
 
 /**
  * @brief Process and validate the passed in block with the chainstate

src/kernel/bitcoinkernel_wrapper.h

@@ -732,8 +732,6 @@ class Block : public Handle<btck_Block, btck_block_copy, btck_block_destroy>
     {
         return write_bytes(get(), btck_block_to_bytes);
     }
-
-    friend class ChainMan;
 };
 
 inline void logging_disable()
@@ -803,9 +801,6 @@ class BlockTreeEntry : public View<btck_BlockTreeEntry>
     {
         return BlockHashView{btck_block_tree_entry_get_block_hash(get())};
     }
-
-    friend class ChainMan;
-    friend class Chain;
 };
 
 class KernelNotifications
@@ -873,7 +868,7 @@ class ChainParams : public Handle<btck_ChainParameters, btck_chain_parameters_co
         : Handle{btck_chain_parameters_create(static_cast<btck_ChainType>(chain_type))} {}
 };
 
-class ContextOptions : UniqueHandle<btck_ContextOptions, btck_context_options_destroy>
+class ContextOptions : public UniqueHandle<btck_ContextOptions, btck_context_options_destroy>
 {
 public:
     ContextOptions() : UniqueHandle{btck_context_options_create()} {}
@@ -921,8 +916,6 @@ class ContextOptions : UniqueHandle<btck_ContextOptions, btck_context_options_de
                 .block_disconnected = +[](void* user_data, btck_Block* block, const btck_BlockTreeEntry* entry) { (*static_cast<user_type>(user_data))->BlockDisconnected(Block{block}, BlockTreeEntry{entry}); },
             });
     }
-
-    friend class Context;
 };
 
 class Context : public Handle<btck_Context, btck_context_copy, btck_context_destroy>
@@ -940,7 +933,7 @@ class Context : public Handle<btck_Context, btck_context_copy, btck_context_dest
     }
 };
 
-class ChainstateManagerOptions : UniqueHandle<btck_ChainstateManagerOptions, btck_chainstate_manager_options_destroy>
+class ChainstateManagerOptions : public UniqueHandle<btck_ChainstateManagerOptions, btck_chainstate_manager_options_destroy>
 {
 public:
     ChainstateManagerOptions(const Context& context, const std::string& data_dir, const std::string& blocks_dir)
@@ -967,8 +960,6 @@ class ChainstateManagerOptions : UniqueHandle<btck_ChainstateManagerOptions, btc
     {
         btck_chainstate_manager_options_update_chainstate_db_in_memory(get(), chainstate_db_in_memory);
     }
-
-    friend class ChainMan;
 };
 
 class ChainView : public View<btck_Chain>

src/test/kernel/test_kernel.cpp

@@ -635,8 +635,6 @@ std::unique_ptr<ChainMan> create_chainman(TestDirectory& test_directory,
                                           bool chainstate_db_in_memory,
                                           Context& context)
 {
-    auto mainnet_test_directory{TestDirectory{"mainnet_test_bitcoin_kernel"}};
-
     ChainstateManagerOptions chainman_opts{context, test_directory.m_directory.string(), (test_directory.m_directory / "blocks").string()};
 
     if (reindex) {
@@ -658,8 +656,6 @@ std::unique_ptr<ChainMan> create_chainman(TestDirectory& test_directory,
 
 void chainman_reindex_test(TestDirectory& test_directory)
 {
-    auto mainnet_test_directory{TestDirectory{"mainnet_test_bitcoin_kernel"}};
-
     auto notifications{std::make_shared<TestKernelNotifications>()};
     auto context{create_context(notifications, ChainType::MAINNET)};
     auto chainman{create_chainman(test_directory, true, false, false, false, context)};