_ Git - ldk-c-bindings/blob - lightning-c-bindings/src/lightning_background_processor.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history and in the source files from which this was generated.
   3 //
   4 // This file is licensed under the license available in the LICENSE or LICENSE.md
   5 // file in the root of this repository or, if no such file exists, the same
   6 // license as that which applies to the original source files from which this
   7 // source was automatically generated.
   8
   9 //! Utilities that take care of tasks that (1) need to happen periodically to keep Rust-Lightning
  10 //! running properly, and (2) either can or should be run in the background. See docs for
  11 //! [`BackgroundProcessor`] for more details on the nitty-gritty.
  12
  13 use alloc::str::FromStr;
  14 use core::ffi::c_void;
  15 use core::convert::Infallible;
  16 use bitcoin::hashes::Hash;
  17 use crate::c_types::*;
  18 #[cfg(feature="no-std")]
  19 use alloc::{vec::Vec, boxed::Box};
  20
  21
  22 use lightning_background_processor::BackgroundProcessor as nativeBackgroundProcessorImport;
  23 pub(crate) type nativeBackgroundProcessor = nativeBackgroundProcessorImport;
  24
  25 /// `BackgroundProcessor` takes care of tasks that (1) need to happen periodically to keep
  26 /// Rust-Lightning running properly, and (2) either can or should be run in the background. Its
  27 /// responsibilities are:
  28 /// * Processing [`Event`]s with a user-provided [`EventHandler`].
  29 /// * Monitoring whether the [`ChannelManager`] needs to be re-persisted to disk, and if so,
  30 ///   writing it to disk/backups by invoking the callback given to it at startup.
  31 ///   [`ChannelManager`] persistence should be done in the background.
  32 /// * Calling [`ChannelManager::timer_tick_occurred`] and [`PeerManager::timer_tick_occurred`]
  33 ///   at the appropriate intervals.
  34 /// * Calling [`NetworkGraph::remove_stale_channels`] (if a [`NetGraphMsgHandler`] is provided to
  35 ///   [`BackgroundProcessor::start`]).
  36 ///
  37 /// It will also call [`PeerManager::process_events`] periodically though this shouldn't be relied
  38 /// upon as doing so may result in high latency.
  39 ///
  40 /// # Note
  41 ///
  42 /// If [`ChannelManager`] persistence fails and the persisted manager becomes out-of-date, then
  43 /// there is a risk of channels force-closing on startup when the manager realizes it's outdated.
  44 /// However, as long as [`ChannelMonitor`] backups are sound, no funds besides those used for
  45 /// unilateral chain closure fees are at risk.
  46 ///
  47 /// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
  48 /// [`Event`]: lightning::util::events::Event
  49 ///BackgroundProcessor will immediately stop on drop. It should be stored until shutdown.
  50 #[must_use]
  51 #[repr(C)]
  52 pub struct BackgroundProcessor {
  53         /// A pointer to the opaque Rust object.
  54
  55         /// Nearly everywhere, inner must be non-null, however in places where
  56         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
  57         pub inner: *mut nativeBackgroundProcessor,
  58         /// Indicates that this is the only struct which contains the same pointer.
  59
  60         /// Rust functions which take ownership of an object provided via an argument require
  61         /// this to be true and invalidate the object pointed to by inner.
  62         pub is_owned: bool,
  63 }
  64
  65 impl Drop for BackgroundProcessor {
  66         fn drop(&mut self) {
  67                 if self.is_owned && !<*mut nativeBackgroundProcessor>::is_null(self.inner) {
  68                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
  69                 }
  70         }
  71 }
  72 /// Frees any resources used by the BackgroundProcessor, if is_owned is set and inner is non-NULL.
  73 #[no_mangle]
  74 pub extern "C" fn BackgroundProcessor_free(this_obj: BackgroundProcessor) { }
  75 #[allow(unused)]
  76 /// Used only if an object of this type is returned as a trait impl by a method
  77 pub(crate) extern "C" fn BackgroundProcessor_free_void(this_ptr: *mut c_void) {
  78         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeBackgroundProcessor); }
  79 }
  80 #[allow(unused)]
  81 impl BackgroundProcessor {
  82         pub(crate) fn get_native_ref(&self) -> &'static nativeBackgroundProcessor {
  83                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
  84         }
  85         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeBackgroundProcessor {
  86                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
  87         }
  88         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
  89         pub(crate) fn take_inner(mut self) -> *mut nativeBackgroundProcessor {
  90                 assert!(self.is_owned);
  91                 let ret = ObjOps::untweak_ptr(self.inner);
  92                 self.inner = core::ptr::null_mut();
  93                 ret
  94         }
  95 }
  96 /// Trait which handles persisting a [`ChannelManager`] to disk.
  97 ///
  98 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
  99 #[repr(C)]
 100 pub struct ChannelManagerPersister {
 101         /// An opaque pointer which is passed to your function implementations as an argument.
 102         /// This has no meaning in the LDK, and can be NULL or any other value.
 103         pub this_arg: *mut c_void,
 104         /// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
 105         /// (which will cause the [`BackgroundProcessor`] which called this method to exit.
 106         ///
 107         /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 108         #[must_use]
 109         pub persist_manager: extern "C" fn (this_arg: *const c_void, channel_manager: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::c_types::derived::CResult_NoneErrorZ,
 110         /// Frees any resources associated with this object given its this_arg pointer.
 111         /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
 112         pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
 113 }
 114 unsafe impl Send for ChannelManagerPersister {}
 115 unsafe impl Sync for ChannelManagerPersister {}
 116 #[no_mangle]
 117 pub(crate) extern "C" fn ChannelManagerPersister_clone_fields(orig: &ChannelManagerPersister) -> ChannelManagerPersister {
 118         ChannelManagerPersister {
 119                 this_arg: orig.this_arg,
 120                 persist_manager: Clone::clone(&orig.persist_manager),
 121                 free: Clone::clone(&orig.free),
 122         }
 123 }
 124
 125 use lightning_background_processor::ChannelManagerPersister as rustChannelManagerPersister;
 126 impl rustChannelManagerPersister<crate::lightning::chain::keysinterface::Sign, crate::lightning::chain::Watch, crate::lightning::chain::chaininterface::BroadcasterInterface, crate::lightning::chain::keysinterface::KeysInterface, crate::lightning::chain::chaininterface::FeeEstimator, crate::lightning::util::logger::Logger> for ChannelManagerPersister {
 127         fn persist_manager(&self, mut channel_manager: &lightning::ln::channelmanager::ChannelManager<crate::lightning::chain::keysinterface::Sign, crate::lightning::chain::Watch, crate::lightning::chain::chaininterface::BroadcasterInterface, crate::lightning::chain::keysinterface::KeysInterface, crate::lightning::chain::chaininterface::FeeEstimator, crate::lightning::util::logger::Logger>) -> Result<(), std::io::Error> {
 128                 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 lightning::ln::channelmanager::ChannelManager<_, _, _, _, _, _, >) as *mut _) }, is_owned: false });
 129                 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() })};
 130                 local_ret
 131         }
 132 }
 133
 134 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
 135 // directly as a Deref trait in higher-level structs:
 136 impl core::ops::Deref for ChannelManagerPersister {
 137         type Target = Self;
 138         fn deref(&self) -> &Self {
 139                 self
 140         }
 141 }
 142 /// Calls the free function if one is set
 143 #[no_mangle]
 144 pub extern "C" fn ChannelManagerPersister_free(this_ptr: ChannelManagerPersister) { }
 145 impl Drop for ChannelManagerPersister {
 146         fn drop(&mut self) {
 147                 if let Some(f) = self.free {
 148                         f(self.this_arg);
 149                 }
 150         }
 151 }
 152 /// Start a background thread that takes care of responsibilities enumerated in the [top-level
 153 /// documentation].
 154 ///
 155 /// The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
 156 /// `persist_manager` returns an error. In case of an error, the error is retrieved by calling
 157 /// either [`join`] or [`stop`].
 158 ///
 159 /// # Data Persistence
 160 ///
 161 /// `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or
 162 /// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
 163 /// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
 164 /// provided implementation.
 165 ///
 166 /// Typically, users should either implement [`ChannelManagerPersister`] to never return an
 167 /// error or call [`join`] and handle any error that may arise. For the latter case,
 168 /// `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
 169 ///
 170 /// # Event Handling
 171 ///
 172 /// `event_handler` is responsible for handling events that users should be notified of (e.g.,
 173 /// payment failed). [`BackgroundProcessor`] may decorate the given [`EventHandler`] with common
 174 /// functionality implemented by other handlers.
 175 /// * [`NetGraphMsgHandler`] if given will update the [`NetworkGraph`] based on payment failures.
 176 ///
 177 /// [top-level documentation]: BackgroundProcessor
 178 /// [`join`]: Self::join
 179 /// [`stop`]: Self::stop
 180 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 181 /// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
 182 /// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
 183 /// [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
 184 ///
 185 /// Note that net_graph_msg_handler (or a relevant inner pointer) may be NULL or all-0s to represent None
 186 #[must_use]
 187 #[no_mangle]
 188 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, mut net_graph_msg_handler: crate::lightning::routing::network_graph::NetGraphMsgHandler, peer_manager: &crate::lightning::ln::peer_handler::PeerManager, mut logger: crate::lightning::util::logger::Logger) -> BackgroundProcessor {
 189         let mut local_net_graph_msg_handler = if net_graph_msg_handler.inner.is_null() { None } else { Some( { net_graph_msg_handler.get_native_ref() }) };
 190         let mut ret = lightning_background_processor::BackgroundProcessor::start(persister, event_handler, chain_monitor.get_native_ref(), channel_manager.get_native_ref(), local_net_graph_msg_handler, peer_manager.get_native_ref(), logger);
 191         BackgroundProcessor { inner: ObjOps::heap_alloc(ret), is_owned: true }
 192 }
 193
 194 /// Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
 195 /// [`ChannelManager`].
 196 ///
 197 /// # Panics
 198 ///
 199 /// This function panics if the background thread has panicked such as while persisting or
 200 /// handling events.
 201 ///
 202 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 203 #[must_use]
 204 #[no_mangle]
 205 pub extern "C" fn BackgroundProcessor_join(mut this_arg: BackgroundProcessor) -> crate::c_types::derived::CResult_NoneErrorZ {
 206         let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).join();
 207         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() };
 208         local_ret
 209 }
 210
 211 /// Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
 212 /// [`ChannelManager`].
 213 ///
 214 /// # Panics
 215 ///
 216 /// This function panics if the background thread has panicked such as while persisting or
 217 /// handling events.
 218 ///
 219 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 220 #[must_use]
 221 #[no_mangle]
 222 pub extern "C" fn BackgroundProcessor_stop(mut this_arg: BackgroundProcessor) -> crate::c_types::derived::CResult_NoneErrorZ {
 223         let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).stop();
 224         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() };
 225         local_ret
 226 }
 227