X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-c-bindings%2Fsrc%2Flightning_background_processor.rs;h=b41229dca1459581acfecc61c666cbecfb943ae9;hb=ae39d0e5a34ef021db50b12a7be96f0694fd1b18;hp=5279e3aa3dbac22411b363a46b322fbc33f13678;hpb=696382c9fbc707aa5226f73910625136adb724fd;p=ldk-c-bindings diff --git a/lightning-c-bindings/src/lightning_background_processor.rs b/lightning-c-bindings/src/lightning_background_processor.rs index 5279e3a..b41229d 100644 --- a/lightning-c-bindings/src/lightning_background_processor.rs +++ b/lightning-c-bindings/src/lightning_background_processor.rs @@ -10,29 +10,42 @@ //! running properly, and (2) either can or should be run in the background. See docs for //! [`BackgroundProcessor`] for more details on the nitty-gritty. -use std::str::FromStr; -use std::ffi::c_void; +use alloc::str::FromStr; +use core::ffi::c_void; +use core::convert::Infallible; use bitcoin::hashes::Hash; use crate::c_types::*; +#[cfg(feature="no-std")] +use alloc::{vec::Vec, boxed::Box}; use lightning_background_processor::BackgroundProcessor as nativeBackgroundProcessorImport; -type nativeBackgroundProcessor = nativeBackgroundProcessorImport; +pub(crate) type nativeBackgroundProcessor = nativeBackgroundProcessorImport; -/// BackgroundProcessor takes care of tasks that (1) need to happen periodically to keep +/// `BackgroundProcessor` takes care of tasks that (1) need to happen periodically to keep /// Rust-Lightning running properly, and (2) either can or should be run in the background. Its /// responsibilities are: -/// * Monitoring whether the ChannelManager needs to be re-persisted to disk, and if so, +/// * Processing [`Event`]s with a user-provided [`EventHandler`]. +/// * Monitoring whether the [`ChannelManager`] needs to be re-persisted to disk, and if so, /// writing it to disk/backups by invoking the callback given to it at startup. -/// ChannelManager persistence should be done in the background. -/// * Calling `ChannelManager::timer_tick_occurred()` and -/// `PeerManager::timer_tick_occurred()` every minute (can be done in the -/// background). -/// -/// Note that if ChannelManager persistence fails and the persisted manager becomes out-of-date, -/// then there is a risk of channels force-closing on startup when the manager realizes it's -/// outdated. However, as long as `ChannelMonitor` backups are sound, no funds besides those used -/// for unilateral chain closure fees are at risk. +/// [`ChannelManager`] persistence should be done in the background. +/// * Calling [`ChannelManager::timer_tick_occurred`] and [`PeerManager::timer_tick_occurred`] +/// at the appropriate intervals. +/// * Calling [`NetworkGraph::remove_stale_channels`] (if a [`GossipSync`] with a [`NetworkGraph`] +/// is provided to [`BackgroundProcessor::start`]). +/// +/// It will also call [`PeerManager::process_events`] periodically though this shouldn't be relied +/// upon as doing so may result in high latency. +/// +/// # Note +/// +/// If [`ChannelManager`] persistence fails and the persisted manager becomes out-of-date, then +/// there is a risk of channels force-closing on startup when the manager realizes it's outdated. +/// However, as long as [`ChannelMonitor`] backups are sound, no funds besides those used for +/// unilateral chain closure fees are at risk. +/// +/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor +/// [`Event`]: lightning::util::events::Event ///BackgroundProcessor will immediately stop on drop. It should be stored until shutdown. #[must_use] #[repr(C)] @@ -61,7 +74,7 @@ impl Drop for BackgroundProcessor { pub extern "C" fn BackgroundProcessor_free(this_obj: BackgroundProcessor) { } #[allow(unused)] /// Used only if an object of this type is returned as a trait impl by a method -extern "C" fn BackgroundProcessor_free_void(this_ptr: *mut c_void) { +pub(crate) extern "C" fn BackgroundProcessor_free_void(this_ptr: *mut c_void) { unsafe { let _ = Box::from_raw(this_ptr as *mut nativeBackgroundProcessor); } } #[allow(unused)] @@ -76,93 +89,131 @@ impl BackgroundProcessor { pub(crate) fn take_inner(mut self) -> *mut nativeBackgroundProcessor { assert!(self.is_owned); let ret = ObjOps::untweak_ptr(self.inner); - self.inner = std::ptr::null_mut(); + self.inner = core::ptr::null_mut(); ret } } -/// Trait which handles persisting a [`ChannelManager`] to disk. -/// -/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager +/// Either [`P2PGossipSync`] or [`RapidGossipSync`]. +#[must_use] #[repr(C)] -pub struct ChannelManagerPersister { - /// An opaque pointer which is passed to your function implementations as an argument. - /// This has no meaning in the LDK, and can be NULL or any other value. - pub this_arg: *mut c_void, - /// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed - /// (which will cause the [`BackgroundProcessor`] which called this method to exit. - /// - /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager - #[must_use] - pub persist_manager: extern "C" fn (this_arg: *const c_void, channel_manager: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::c_types::derived::CResult_NoneErrorZ, - /// Frees any resources associated with this object given its this_arg pointer. - /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed. - pub free: Option, -} -unsafe impl Send for ChannelManagerPersister {} -unsafe impl Sync for ChannelManagerPersister {} -#[no_mangle] -pub(crate) extern "C" fn ChannelManagerPersister_clone_fields(orig: &ChannelManagerPersister) -> ChannelManagerPersister { - ChannelManagerPersister { - this_arg: orig.this_arg, - persist_manager: Clone::clone(&orig.persist_manager), - free: Clone::clone(&orig.free), - } +pub enum GossipSync { + /// Gossip sync via the lightning peer-to-peer network as defined by BOLT 7. + P2P( + /// Note that this field is expected to be a reference. + crate::lightning::routing::gossip::P2PGossipSync), + /// Rapid gossip sync from a trusted server. + Rapid( + /// Note that this field is expected to be a reference. + crate::lightning_rapid_gossip_sync::RapidGossipSync), + /// No gossip sync. + None, } +use lightning_background_processor::GossipSync as GossipSyncImport; +pub(crate) type nativeGossipSync = GossipSyncImport<&'static lightning::routing::gossip::P2PGossipSync<&'static lightning::routing::gossip::NetworkGraph, crate::lightning::chain::Access, crate::lightning::util::logger::Logger>, &'static lightning_rapid_gossip_sync::RapidGossipSync<&'static lightning::routing::gossip::NetworkGraph, crate::lightning::util::logger::Logger>, &'static lightning::routing::gossip::NetworkGraph, crate::lightning::chain::Access, crate::lightning::util::logger::Logger>; -use lightning_background_processor::ChannelManagerPersister as rustChannelManagerPersister; -impl rustChannelManagerPersister for ChannelManagerPersister { - fn persist_manager(&self, mut channel_manager: &lightning::ln::channelmanager::ChannelManager) -> Result<(), std::io::Error> { - let mut ret = (self.persist_manager)(self.this_arg, &crate::lightning::ln::channelmanager::ChannelManager { inner: unsafe { ObjOps::nonnull_ptr_to_inner((channel_manager as *const _) as *mut _) }, is_owned: false }); - let mut local_ret = match ret.result_ok { true => Ok( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) })*/ }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) }).to_rust() })}; - local_ret +impl GossipSync { + #[allow(unused)] + pub(crate) fn into_native(self) -> nativeGossipSync { + match self { + GossipSync::P2P (mut a, ) => { + nativeGossipSync::P2P ( + a.get_native_ref(), + ) + }, + GossipSync::Rapid (mut a, ) => { + nativeGossipSync::Rapid ( + a.get_native_ref(), + ) + }, + GossipSync::None => nativeGossipSync::None, + } } -} - -// We're essentially a pointer already, or at least a set of pointers, so allow us to be used -// directly as a Deref trait in higher-level structs: -impl std::ops::Deref for ChannelManagerPersister { - type Target = Self; - fn deref(&self) -> &Self { - self + #[allow(unused)] + pub(crate) fn native_into(native: nativeGossipSync) -> Self { + match native { + nativeGossipSync::P2P (mut a, ) => { + GossipSync::P2P ( + crate::lightning::routing::gossip::P2PGossipSync { inner: unsafe { ObjOps::nonnull_ptr_to_inner((a as *const lightning::routing::gossip::P2PGossipSync<_, _, _, >) as *mut _) }, is_owned: false }, + ) + }, + nativeGossipSync::Rapid (mut a, ) => { + GossipSync::Rapid ( + crate::lightning_rapid_gossip_sync::RapidGossipSync { inner: unsafe { ObjOps::nonnull_ptr_to_inner((a as *const lightning_rapid_gossip_sync::RapidGossipSync<_, _, >) as *mut _) }, is_owned: false }, + ) + }, + nativeGossipSync::None => GossipSync::None, + } } } -/// Calls the free function if one is set +/// Frees any resources used by the GossipSync #[no_mangle] -pub extern "C" fn ChannelManagerPersister_free(this_ptr: ChannelManagerPersister) { } -impl Drop for ChannelManagerPersister { - fn drop(&mut self) { - if let Some(f) = self.free { - f(self.this_arg); - } - } +pub extern "C" fn GossipSync_free(this_ptr: GossipSync) { } +#[no_mangle] +/// Utility method to constructs a new P2P-variant GossipSync +pub extern "C" fn GossipSync_p2_p(a: &crate::lightning::routing::gossip::P2PGossipSync) -> GossipSync { + GossipSync::P2P(crate::lightning::routing::gossip::P2PGossipSync { inner: a.inner, is_owned: false }, ) +} +#[no_mangle] +/// Utility method to constructs a new Rapid-variant GossipSync +pub extern "C" fn GossipSync_rapid(a: &crate::lightning_rapid_gossip_sync::RapidGossipSync) -> GossipSync { + GossipSync::Rapid(crate::lightning_rapid_gossip_sync::RapidGossipSync { inner: a.inner, is_owned: false }, ) } +#[no_mangle] +/// Utility method to constructs a new None-variant GossipSync +pub extern "C" fn GossipSync_none() -> GossipSync { + GossipSync::None} /// Start a background thread that takes care of responsibilities enumerated in the [top-level /// documentation]. /// /// The thread runs indefinitely unless the object is dropped, [`stop`] is called, or -/// `persist_manager` returns an error. In case of an error, the error is retrieved by calling +/// [`Persister::persist_manager`] returns an error. In case of an error, the error is retrieved by calling /// either [`join`] or [`stop`]. /// -/// Typically, users should either implement [`ChannelManagerPersister`] to never return an -/// error or call [`join`] and handle any error that may arise. For the latter case, the -/// `BackgroundProcessor` must be restarted by calling `start` again after handling the error. +/// # Data Persistence /// -/// `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or +/// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or /// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a -/// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's +/// [`ChannelManager`]. See the `lightning-persister` crate for LDK's /// provided implementation. /// -/// [top-level documentation]: Self +/// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk, if +/// [`GossipSync`] is supplied. See [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. +/// See the `lightning-persister` crate for LDK's provided implementation. +/// +/// Typically, users should either implement [`Persister::persist_manager`] to never return an +/// error or call [`join`] and handle any error that may arise. For the latter case, +/// `BackgroundProcessor` must be restarted by calling `start` again after handling the error. +/// +/// # Event Handling +/// +/// `event_handler` is responsible for handling events that users should be notified of (e.g., +/// payment failed). [`BackgroundProcessor`] may decorate the given [`EventHandler`] with common +/// functionality implemented by other handlers. +/// * [`P2PGossipSync`] if given will update the [`NetworkGraph`] based on payment failures. +/// +/// # Rapid Gossip Sync +/// +/// If rapid gossip sync is meant to run at startup, pass a [`RapidGossipSync`] to `gossip_sync` +/// to indicate that the [`BackgroundProcessor`] should not prune the [`NetworkGraph`] instance +/// until the [`RapidGossipSync`] instance completes its first sync. +/// +/// [top-level documentation]: BackgroundProcessor /// [`join`]: Self::join /// [`stop`]: Self::stop /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager /// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable -/// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager +/// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager +/// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph +/// [`NetworkGraph`]: lightning::routing::gossip::NetworkGraph +/// [`NetworkGraph::write`]: lightning::routing::gossip::NetworkGraph#impl-Writeable +/// +/// Note that scorer (or a relevant inner pointer) may be NULL or all-0s to represent None #[must_use] #[no_mangle] -pub extern "C" fn BackgroundProcessor_start(mut persister: crate::lightning_background_processor::ChannelManagerPersister, mut event_handler: crate::lightning::util::events::EventHandler, chain_monitor: &crate::lightning::chain::chainmonitor::ChainMonitor, channel_manager: &crate::lightning::ln::channelmanager::ChannelManager, peer_manager: &crate::lightning::ln::peer_handler::PeerManager, mut logger: crate::lightning::util::logger::Logger) -> BackgroundProcessor { - let mut ret = lightning_background_processor::BackgroundProcessor::start(persister, event_handler, chain_monitor.get_native_ref(), channel_manager.get_native_ref(), peer_manager.get_native_ref(), logger); - BackgroundProcessor { inner: ObjOps::heap_alloc(ret), is_owned: true } +pub extern "C" fn BackgroundProcessor_start(mut persister: crate::lightning::util::persist::Persister, mut event_handler: crate::lightning::util::events::EventHandler, chain_monitor: &crate::lightning::chain::chainmonitor::ChainMonitor, channel_manager: &crate::lightning::ln::channelmanager::ChannelManager, mut gossip_sync: crate::lightning_background_processor::GossipSync, peer_manager: &crate::lightning::ln::peer_handler::PeerManager, mut logger: crate::lightning::util::logger::Logger, mut scorer: crate::lightning::routing::scoring::MultiThreadedLockableScore) -> crate::lightning_background_processor::BackgroundProcessor { + let mut local_scorer = if scorer.inner.is_null() { None } else { Some( { scorer.get_native_ref() }) }; + let mut ret = lightning_background_processor::BackgroundProcessor::start(persister, event_handler, chain_monitor.get_native_ref(), channel_manager.get_native_ref(), gossip_sync.into_native(), peer_manager.get_native_ref(), logger, local_scorer); + crate::lightning_background_processor::BackgroundProcessor { inner: ObjOps::heap_alloc(ret), is_owned: true } } /// Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting @@ -176,7 +227,7 @@ pub extern "C" fn BackgroundProcessor_start(mut persister: crate::lightning_back /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager #[must_use] #[no_mangle] -pub extern "C" fn BackgroundProcessor_join(mut this_arg: BackgroundProcessor) -> crate::c_types::derived::CResult_NoneErrorZ { +pub extern "C" fn BackgroundProcessor_join(mut this_arg: crate::lightning_background_processor::BackgroundProcessor) -> crate::c_types::derived::CResult_NoneErrorZ { let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).join(); let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::c_types::IOError::from_rust(e) }).into() }; local_ret @@ -193,7 +244,7 @@ pub extern "C" fn BackgroundProcessor_join(mut this_arg: BackgroundProcessor) -> /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager #[must_use] #[no_mangle] -pub extern "C" fn BackgroundProcessor_stop(mut this_arg: BackgroundProcessor) -> crate::c_types::derived::CResult_NoneErrorZ { +pub extern "C" fn BackgroundProcessor_stop(mut this_arg: crate::lightning_background_processor::BackgroundProcessor) -> crate::c_types::derived::CResult_NoneErrorZ { let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).stop(); let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::c_types::IOError::from_rust(e) }).into() }; local_ret