_ 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 std::str::FromStr;
  14 use std::ffi::c_void;
  15 use bitcoin::hashes::Hash;
  16 use crate::c_types::*;
  17
  18
  19 use lightning_background_processor::BackgroundProcessor as nativeBackgroundProcessorImport;
  20 type nativeBackgroundProcessor = nativeBackgroundProcessorImport;
  21
  22 /// BackgroundProcessor takes care of tasks that (1) need to happen periodically to keep
  23 /// Rust-Lightning running properly, and (2) either can or should be run in the background. Its
  24 /// responsibilities are:
  25 /// * Monitoring whether the ChannelManager needs to be re-persisted to disk, and if so,
  26 ///   writing it to disk/backups by invoking the callback given to it at startup.
  27 ///   ChannelManager persistence should be done in the background.
  28 /// * Calling `ChannelManager::timer_tick_occurred()` and
  29 ///   `PeerManager::timer_tick_occurred()` every minute (can be done in the
  30 ///   background).
  31 ///
  32 /// Note that if ChannelManager persistence fails and the persisted manager becomes out-of-date,
  33 /// then there is a risk of channels force-closing on startup when the manager realizes it's
  34 /// outdated. However, as long as `ChannelMonitor` backups are sound, no funds besides those used
  35 /// for unilateral chain closure fees are at risk.
  36 ///BackgroundProcessor will immediately stop on drop. It should be stored until shutdown.
  37 #[must_use]
  38 #[repr(C)]
  39 pub struct BackgroundProcessor {
  40         /// A pointer to the opaque Rust object.
  41
  42         /// Nearly everywhere, inner must be non-null, however in places where
  43         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
  44         pub inner: *mut nativeBackgroundProcessor,
  45         /// Indicates that this is the only struct which contains the same pointer.
  46
  47         /// Rust functions which take ownership of an object provided via an argument require
  48         /// this to be true and invalidate the object pointed to by inner.
  49         pub is_owned: bool,
  50 }
  51
  52 impl Drop for BackgroundProcessor {
  53         fn drop(&mut self) {
  54                 if self.is_owned && !<*mut nativeBackgroundProcessor>::is_null(self.inner) {
  55                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
  56                 }
  57         }
  58 }
  59 /// Frees any resources used by the BackgroundProcessor, if is_owned is set and inner is non-NULL.
  60 #[no_mangle]
  61 pub extern "C" fn BackgroundProcessor_free(this_obj: BackgroundProcessor) { }
  62 #[allow(unused)]
  63 /// Used only if an object of this type is returned as a trait impl by a method
  64 extern "C" fn BackgroundProcessor_free_void(this_ptr: *mut c_void) {
  65         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeBackgroundProcessor); }
  66 }
  67 #[allow(unused)]
  68 impl BackgroundProcessor {
  69         pub(crate) fn get_native_ref(&self) -> &'static nativeBackgroundProcessor {
  70                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
  71         }
  72         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeBackgroundProcessor {
  73                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
  74         }
  75         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
  76         pub(crate) fn take_inner(mut self) -> *mut nativeBackgroundProcessor {
  77                 assert!(self.is_owned);
  78                 let ret = ObjOps::untweak_ptr(self.inner);
  79                 self.inner = std::ptr::null_mut();
  80                 ret
  81         }
  82 }
  83 /// Trait which handles persisting a [`ChannelManager`] to disk.
  84 ///
  85 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
  86 #[repr(C)]
  87 pub struct ChannelManagerPersister {
  88         /// An opaque pointer which is passed to your function implementations as an argument.
  89         /// This has no meaning in the LDK, and can be NULL or any other value.
  90         pub this_arg: *mut c_void,
  91         /// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
  92         /// (which will cause the [`BackgroundProcessor`] which called this method to exit.
  93         ///
  94         /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
  95         #[must_use]
  96         pub persist_manager: extern "C" fn (this_arg: *const c_void, channel_manager: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::c_types::derived::CResult_NoneErrorZ,
  97         /// Frees any resources associated with this object given its this_arg pointer.
  98         /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
  99         pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
 100 }
 101 unsafe impl Send for ChannelManagerPersister {}
 102 unsafe impl Sync for ChannelManagerPersister {}
 103 #[no_mangle]
 104 pub(crate) extern "C" fn ChannelManagerPersister_clone_fields(orig: &ChannelManagerPersister) -> ChannelManagerPersister {
 105         ChannelManagerPersister {
 106                 this_arg: orig.this_arg,
 107                 persist_manager: Clone::clone(&orig.persist_manager),
 108                 free: Clone::clone(&orig.free),
 109         }
 110 }
 111
 112 use lightning_background_processor::ChannelManagerPersister as rustChannelManagerPersister;
 113 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 {
 114         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> {
 115                 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 });
 116                 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() })};
 117                 local_ret
 118         }
 119 }
 120
 121 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
 122 // directly as a Deref trait in higher-level structs:
 123 impl std::ops::Deref for ChannelManagerPersister {
 124         type Target = Self;
 125         fn deref(&self) -> &Self {
 126                 self
 127         }
 128 }
 129 /// Calls the free function if one is set
 130 #[no_mangle]
 131 pub extern "C" fn ChannelManagerPersister_free(this_ptr: ChannelManagerPersister) { }
 132 impl Drop for ChannelManagerPersister {
 133         fn drop(&mut self) {
 134                 if let Some(f) = self.free {
 135                         f(self.this_arg);
 136                 }
 137         }
 138 }
 139 /// Start a background thread that takes care of responsibilities enumerated in the [top-level
 140 /// documentation].
 141 ///
 142 /// The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
 143 /// `persist_manager` returns an error. In case of an error, the error is retrieved by calling
 144 /// either [`join`] or [`stop`].
 145 ///
 146 /// Typically, users should either implement [`ChannelManagerPersister`] to never return an
 147 /// error or call [`join`] and handle any error that may arise. For the latter case, the
 148 /// `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
 149 ///
 150 /// `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or
 151 /// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
 152 /// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
 153 /// provided implementation.
 154 ///
 155 /// [top-level documentation]: Self
 156 /// [`join`]: Self::join
 157 /// [`stop`]: Self::stop
 158 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 159 /// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
 160 /// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
 161 #[must_use]
 162 #[no_mangle]
 163 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 {
 164         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);
 165         BackgroundProcessor { inner: ObjOps::heap_alloc(ret), is_owned: true }
 166 }
 167
 168 /// Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
 169 /// [`ChannelManager`].
 170 ///
 171 /// # Panics
 172 ///
 173 /// This function panics if the background thread has panicked such as while persisting or
 174 /// handling events.
 175 ///
 176 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 177 #[must_use]
 178 #[no_mangle]
 179 pub extern "C" fn BackgroundProcessor_join(mut this_arg: BackgroundProcessor) -> crate::c_types::derived::CResult_NoneErrorZ {
 180         let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).join();
 181         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() };
 182         local_ret
 183 }
 184
 185 /// Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
 186 /// [`ChannelManager`].
 187 ///
 188 /// # Panics
 189 ///
 190 /// This function panics if the background thread has panicked such as while persisting or
 191 /// handling events.
 192 ///
 193 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 194 #[must_use]
 195 #[no_mangle]
 196 pub extern "C" fn BackgroundProcessor_stop(mut this_arg: BackgroundProcessor) -> crate::c_types::derived::CResult_NoneErrorZ {
 197         let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).stop();
 198         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() };
 199         local_ret
 200 }
 201