_ Git - ldk-c-bindings/blob - lightning-c-bindings/src/lightning/util/logger.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 //! Log traits live here, which are called throughout the library to provide useful information for
  10 //! debugging purposes.
  11 //!
  12 //! There is currently 2 ways to filter log messages. First one, by using compilation features, e.g \"max_level_off\".
  13 //! The second one, client-side by implementing check against Record Level field.
  14 //! Each module may have its own Logger or share one.
  15
  16 use alloc::str::FromStr;
  17 use alloc::string::String;
  18 use core::ffi::c_void;
  19 use core::convert::Infallible;
  20 use bitcoin::hashes::Hash;
  21 use crate::c_types::*;
  22 #[cfg(feature="no-std")]
  23 use alloc::{vec::Vec, boxed::Box};
  24
  25 /// An enum representing the available verbosity levels of the logger.
  26 #[derive(Clone)]
  27 #[must_use]
  28 #[repr(C)]
  29 pub enum Level {
  30         /// Designates extremely verbose information, including gossip-induced messages
  31         Gossip,
  32         /// Designates very low priority, often extremely verbose, information
  33         Trace,
  34         /// Designates lower priority information
  35         Debug,
  36         /// Designates useful information
  37         Info,
  38         /// Designates hazardous situations
  39         Warn,
  40         /// Designates very serious errors
  41         Error,
  42 }
  43 use lightning::util::logger::Level as LevelImport;
  44 pub(crate) type nativeLevel = LevelImport;
  45
  46 impl Level {
  47         #[allow(unused)]
  48         pub(crate) fn to_native(&self) -> nativeLevel {
  49                 match self {
  50                         Level::Gossip => nativeLevel::Gossip,
  51                         Level::Trace => nativeLevel::Trace,
  52                         Level::Debug => nativeLevel::Debug,
  53                         Level::Info => nativeLevel::Info,
  54                         Level::Warn => nativeLevel::Warn,
  55                         Level::Error => nativeLevel::Error,
  56                 }
  57         }
  58         #[allow(unused)]
  59         pub(crate) fn into_native(self) -> nativeLevel {
  60                 match self {
  61                         Level::Gossip => nativeLevel::Gossip,
  62                         Level::Trace => nativeLevel::Trace,
  63                         Level::Debug => nativeLevel::Debug,
  64                         Level::Info => nativeLevel::Info,
  65                         Level::Warn => nativeLevel::Warn,
  66                         Level::Error => nativeLevel::Error,
  67                 }
  68         }
  69         #[allow(unused)]
  70         pub(crate) fn from_native(native: &LevelImport) -> Self {
  71                 let native = unsafe { &*(native as *const _ as *const c_void as *const nativeLevel) };
  72                 match native {
  73                         nativeLevel::Gossip => Level::Gossip,
  74                         nativeLevel::Trace => Level::Trace,
  75                         nativeLevel::Debug => Level::Debug,
  76                         nativeLevel::Info => Level::Info,
  77                         nativeLevel::Warn => Level::Warn,
  78                         nativeLevel::Error => Level::Error,
  79                 }
  80         }
  81         #[allow(unused)]
  82         pub(crate) fn native_into(native: nativeLevel) -> Self {
  83                 match native {
  84                         nativeLevel::Gossip => Level::Gossip,
  85                         nativeLevel::Trace => Level::Trace,
  86                         nativeLevel::Debug => Level::Debug,
  87                         nativeLevel::Info => Level::Info,
  88                         nativeLevel::Warn => Level::Warn,
  89                         nativeLevel::Error => Level::Error,
  90                 }
  91         }
  92 }
  93 /// Creates a copy of the Level
  94 #[no_mangle]
  95 pub extern "C" fn Level_clone(orig: &Level) -> Level {
  96         orig.clone()
  97 }
  98 #[allow(unused)]
  99 /// Used only if an object of this type is returned as a trait impl by a method
 100 pub(crate) extern "C" fn Level_clone_void(this_ptr: *const c_void) -> *mut c_void {
 101         Box::into_raw(Box::new(unsafe { (*(this_ptr as *const Level)).clone() })) as *mut c_void
 102 }
 103 #[allow(unused)]
 104 /// Used only if an object of this type is returned as a trait impl by a method
 105 pub(crate) extern "C" fn Level_free_void(this_ptr: *mut c_void) {
 106         let _ = unsafe { Box::from_raw(this_ptr as *mut Level) };
 107 }
 108 #[no_mangle]
 109 /// Utility method to constructs a new Gossip-variant Level
 110 pub extern "C" fn Level_gossip() -> Level {
 111         Level::Gossip}
 112 #[no_mangle]
 113 /// Utility method to constructs a new Trace-variant Level
 114 pub extern "C" fn Level_trace() -> Level {
 115         Level::Trace}
 116 #[no_mangle]
 117 /// Utility method to constructs a new Debug-variant Level
 118 pub extern "C" fn Level_debug() -> Level {
 119         Level::Debug}
 120 #[no_mangle]
 121 /// Utility method to constructs a new Info-variant Level
 122 pub extern "C" fn Level_info() -> Level {
 123         Level::Info}
 124 #[no_mangle]
 125 /// Utility method to constructs a new Warn-variant Level
 126 pub extern "C" fn Level_warn() -> Level {
 127         Level::Warn}
 128 #[no_mangle]
 129 /// Utility method to constructs a new Error-variant Level
 130 pub extern "C" fn Level_error() -> Level {
 131         Level::Error}
 132 /// Checks if two Levels contain equal inner contents.
 133 /// This ignores pointers and is_owned flags and looks at the values in fields.
 134 #[no_mangle]
 135 pub extern "C" fn Level_eq(a: &Level, b: &Level) -> bool {
 136         if &a.to_native() == &b.to_native() { true } else { false }
 137 }
 138 /// Get a string which allows debug introspection of a Level object
 139 pub extern "C" fn Level_debug_str_void(o: *const c_void) -> Str {
 140         alloc::format!("{:?}", unsafe { o as *const crate::lightning::util::logger::Level }).into()}
 141 /// Generates a non-cryptographic 64-bit hash of the Level.
 142 #[no_mangle]
 143 pub extern "C" fn Level_hash(o: &Level) -> u64 {
 144         // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
 145         #[allow(deprecated)]
 146         let mut hasher = core::hash::SipHasher::new();
 147         core::hash::Hash::hash(&o.to_native(), &mut hasher);
 148         core::hash::Hasher::finish(&hasher)
 149 }
 150 /// Returns the most verbose logging level.
 151 #[must_use]
 152 #[no_mangle]
 153 pub extern "C" fn Level_max() -> crate::lightning::util::logger::Level {
 154         let mut ret = lightning::util::logger::Level::max();
 155         crate::lightning::util::logger::Level::native_into(ret)
 156 }
 157
 158
 159 use lightning::util::logger::Record as nativeRecordImport;
 160 pub(crate) type nativeRecord = nativeRecordImport;
 161
 162 /// A Record, unit of logging output with Metadata to enable filtering
 163 /// Module_path, file, line to inform on log's source
 164 #[must_use]
 165 #[repr(C)]
 166 pub struct Record {
 167         /// A pointer to the opaque Rust object.
 168
 169         /// Nearly everywhere, inner must be non-null, however in places where
 170         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
 171         pub inner: *mut nativeRecord,
 172         /// Indicates that this is the only struct which contains the same pointer.
 173
 174         /// Rust functions which take ownership of an object provided via an argument require
 175         /// this to be true and invalidate the object pointed to by inner.
 176         pub is_owned: bool,
 177 }
 178
 179 impl Drop for Record {
 180         fn drop(&mut self) {
 181                 if self.is_owned && !<*mut nativeRecord>::is_null(self.inner) {
 182                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 183                 }
 184         }
 185 }
 186 /// Frees any resources used by the Record, if is_owned is set and inner is non-NULL.
 187 #[no_mangle]
 188 pub extern "C" fn Record_free(this_obj: Record) { }
 189 #[allow(unused)]
 190 /// Used only if an object of this type is returned as a trait impl by a method
 191 pub(crate) extern "C" fn Record_free_void(this_ptr: *mut c_void) {
 192         let _ = unsafe { Box::from_raw(this_ptr as *mut nativeRecord) };
 193 }
 194 #[allow(unused)]
 195 impl Record {
 196         pub(crate) fn get_native_ref(&self) -> &'static nativeRecord {
 197                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 198         }
 199         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRecord {
 200                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 201         }
 202         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
 203         pub(crate) fn take_inner(mut self) -> *mut nativeRecord {
 204                 assert!(self.is_owned);
 205                 let ret = ObjOps::untweak_ptr(self.inner);
 206                 self.inner = core::ptr::null_mut();
 207                 ret
 208         }
 209 }
 210 /// The verbosity level of the message.
 211 #[no_mangle]
 212 pub extern "C" fn Record_get_level(this_ptr: &Record) -> crate::lightning::util::logger::Level {
 213         let mut inner_val = &mut this_ptr.get_native_mut_ref().level;
 214         crate::lightning::util::logger::Level::from_native(inner_val)
 215 }
 216 /// The verbosity level of the message.
 217 #[no_mangle]
 218 pub extern "C" fn Record_set_level(this_ptr: &mut Record, mut val: crate::lightning::util::logger::Level) {
 219         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.level = val.into_native();
 220 }
 221 /// The node id of the peer pertaining to the logged record.
 222 ///
 223 /// Note that in some cases a [`Self::channel_id`] may be filled in but this may still be
 224 /// `None`, depending on if the peer information is readily available in LDK when the log is
 225 /// generated.
 226 ///
 227 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 228 #[no_mangle]
 229 pub extern "C" fn Record_get_peer_id(this_ptr: &Record) -> crate::c_types::PublicKey {
 230         let mut inner_val = &mut this_ptr.get_native_mut_ref().peer_id;
 231         let mut local_inner_val = if inner_val.is_none() { crate::c_types::PublicKey::null() } else {  { crate::c_types::PublicKey::from_rust(&(inner_val.unwrap())) } };
 232         local_inner_val
 233 }
 234 /// The node id of the peer pertaining to the logged record.
 235 ///
 236 /// Note that in some cases a [`Self::channel_id`] may be filled in but this may still be
 237 /// `None`, depending on if the peer information is readily available in LDK when the log is
 238 /// generated.
 239 ///
 240 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
 241 #[no_mangle]
 242 pub extern "C" fn Record_set_peer_id(this_ptr: &mut Record, mut val: crate::c_types::PublicKey) {
 243         let mut local_val = if val.is_null() { None } else { Some( { val.into_rust() }) };
 244         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.peer_id = local_val;
 245 }
 246 /// The channel id of the channel pertaining to the logged record. May be a temporary id before
 247 /// the channel has been funded.
 248 #[no_mangle]
 249 pub extern "C" fn Record_get_channel_id(this_ptr: &Record) -> crate::c_types::derived::COption_ThirtyTwoBytesZ {
 250         let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_id;
 251         let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_ThirtyTwoBytesZ::None } else { crate::c_types::derived::COption_ThirtyTwoBytesZ::Some(/* WARNING: CLONING CONVERSION HERE! &Option<Enum> is otherwise un-expressable. */ { crate::c_types::ThirtyTwoBytes { data: (*inner_val.as_ref().unwrap()).clone().0 } }) };
 252         local_inner_val
 253 }
 254 /// The channel id of the channel pertaining to the logged record. May be a temporary id before
 255 /// the channel has been funded.
 256 #[no_mangle]
 257 pub extern "C" fn Record_set_channel_id(this_ptr: &mut Record, mut val: crate::c_types::derived::COption_ThirtyTwoBytesZ) {
 258         let mut local_val = { /*val*/ let val_opt = val; if val_opt.is_none() { None } else { Some({ { ::lightning::ln::ChannelId({ val_opt.take() }.data) }})} };
 259         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_id = local_val;
 260 }
 261 /// The message body.
 262 #[no_mangle]
 263 pub extern "C" fn Record_get_args(this_ptr: &Record) -> crate::c_types::Str {
 264         let mut inner_val = &mut this_ptr.get_native_mut_ref().args;
 265         inner_val.as_str().into()
 266 }
 267 /// The message body.
 268 #[no_mangle]
 269 pub extern "C" fn Record_set_args(this_ptr: &mut Record, mut val: crate::c_types::Str) {
 270         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.args = val.into_string();
 271 }
 272 /// The module path of the message.
 273 #[no_mangle]
 274 pub extern "C" fn Record_get_module_path(this_ptr: &Record) -> crate::c_types::Str {
 275         let mut inner_val = &mut this_ptr.get_native_mut_ref().module_path;
 276         inner_val.into()
 277 }
 278 /// The module path of the message.
 279 #[no_mangle]
 280 pub extern "C" fn Record_set_module_path(this_ptr: &mut Record, mut val: crate::c_types::Str) {
 281         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.module_path = val.into_str();
 282 }
 283 /// The source file containing the message.
 284 #[no_mangle]
 285 pub extern "C" fn Record_get_file(this_ptr: &Record) -> crate::c_types::Str {
 286         let mut inner_val = &mut this_ptr.get_native_mut_ref().file;
 287         inner_val.into()
 288 }
 289 /// The source file containing the message.
 290 #[no_mangle]
 291 pub extern "C" fn Record_set_file(this_ptr: &mut Record, mut val: crate::c_types::Str) {
 292         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.file = val.into_str();
 293 }
 294 /// The line containing the message.
 295 #[no_mangle]
 296 pub extern "C" fn Record_get_line(this_ptr: &Record) -> u32 {
 297         let mut inner_val = &mut this_ptr.get_native_mut_ref().line;
 298         *inner_val
 299 }
 300 /// The line containing the message.
 301 #[no_mangle]
 302 pub extern "C" fn Record_set_line(this_ptr: &mut Record, mut val: u32) {
 303         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.line = val;
 304 }
 305 /// Constructs a new Record given each field
 306 ///
 307 /// Note that peer_id_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 308 #[must_use]
 309 #[no_mangle]
 310 pub extern "C" fn Record_new(mut level_arg: crate::lightning::util::logger::Level, mut peer_id_arg: crate::c_types::PublicKey, mut channel_id_arg: crate::c_types::derived::COption_ThirtyTwoBytesZ, mut args_arg: crate::c_types::Str, mut module_path_arg: crate::c_types::Str, mut file_arg: crate::c_types::Str, mut line_arg: u32) -> Record {
 311         let mut local_peer_id_arg = if peer_id_arg.is_null() { None } else { Some( { peer_id_arg.into_rust() }) };
 312         let mut local_channel_id_arg = { /*channel_id_arg*/ let channel_id_arg_opt = channel_id_arg; if channel_id_arg_opt.is_none() { None } else { Some({ { ::lightning::ln::ChannelId({ channel_id_arg_opt.take() }.data) }})} };
 313         Record { inner: ObjOps::heap_alloc(nativeRecord {
 314                 level: level_arg.into_native(),
 315                 peer_id: local_peer_id_arg,
 316                 channel_id: local_channel_id_arg,
 317                 args: args_arg.into_string(),
 318                 module_path: module_path_arg.into_str(),
 319                 file: file_arg.into_str(),
 320                 line: line_arg,
 321         }), is_owned: true }
 322 }
 323 impl Clone for Record {
 324         fn clone(&self) -> Self {
 325                 Self {
 326                         inner: if <*mut nativeRecord>::is_null(self.inner) { core::ptr::null_mut() } else {
 327                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
 328                         is_owned: true,
 329                 }
 330         }
 331 }
 332 #[allow(unused)]
 333 /// Used only if an object of this type is returned as a trait impl by a method
 334 pub(crate) extern "C" fn Record_clone_void(this_ptr: *const c_void) -> *mut c_void {
 335         Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeRecord)).clone() })) as *mut c_void
 336 }
 337 #[no_mangle]
 338 /// Creates a copy of the Record
 339 pub extern "C" fn Record_clone(orig: &Record) -> Record {
 340         orig.clone()
 341 }
 342 /// Get a string which allows debug introspection of a Record object
 343 pub extern "C" fn Record_debug_str_void(o: *const c_void) -> Str {
 344         alloc::format!("{:?}", unsafe { o as *const crate::lightning::util::logger::Record }).into()}
 345 /// A trait encapsulating the operations required of a logger.
 346 #[repr(C)]
 347 pub struct Logger {
 348         /// An opaque pointer which is passed to your function implementations as an argument.
 349         /// This has no meaning in the LDK, and can be NULL or any other value.
 350         pub this_arg: *mut c_void,
 351         /// Logs the [`Record`].
 352         pub log: extern "C" fn (this_arg: *const c_void, record: crate::lightning::util::logger::Record),
 353         /// Frees any resources associated with this object given its this_arg pointer.
 354         /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
 355         pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
 356 }
 357 unsafe impl Send for Logger {}
 358 unsafe impl Sync for Logger {}
 359 #[allow(unused)]
 360 pub(crate) fn Logger_clone_fields(orig: &Logger) -> Logger {
 361         Logger {
 362                 this_arg: orig.this_arg,
 363                 log: Clone::clone(&orig.log),
 364                 free: Clone::clone(&orig.free),
 365         }
 366 }
 367
 368 use lightning::util::logger::Logger as rustLogger;
 369 impl rustLogger for Logger {
 370         fn log(&self, mut record: lightning::util::logger::Record) {
 371                 (self.log)(self.this_arg, crate::lightning::util::logger::Record { inner: ObjOps::heap_alloc(record), is_owned: true })
 372         }
 373 }
 374
 375 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
 376 // directly as a Deref trait in higher-level structs:
 377 impl core::ops::Deref for Logger {
 378         type Target = Self;
 379         fn deref(&self) -> &Self {
 380                 self
 381         }
 382 }
 383 impl core::ops::DerefMut for Logger {
 384         fn deref_mut(&mut self) -> &mut Self {
 385                 self
 386         }
 387 }
 388 /// Calls the free function if one is set
 389 #[no_mangle]
 390 pub extern "C" fn Logger_free(this_ptr: Logger) { }
 391 impl Drop for Logger {
 392         fn drop(&mut self) {
 393                 if let Some(f) = self.free {
 394                         f(self.this_arg);
 395                 }
 396         }
 397 }