1 // This file is Copyright its original authors, visible in version control
2 // history and in the source files from which this was generated.
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.
9 //! Log traits live here, which are called throughout the library to provide useful information for
10 //! debugging purposes.
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.
16 use alloc::str::FromStr;
17 use core::ffi::c_void;
18 use core::convert::Infallible;
19 use bitcoin::hashes::Hash;
20 use crate::c_types::*;
21 #[cfg(feature="no-std")]
22 use alloc::{vec::Vec, boxed::Box};
24 /// An enum representing the available verbosity levels of the logger.
29 /// Designates extremely verbose information, including gossip-induced messages
31 /// Designates very low priority, often extremely verbose, information
33 /// Designates lower priority information
35 /// Designates useful information
37 /// Designates hazardous situations
39 /// Designates very serious errors
42 use lightning::util::logger::Level as nativeLevel;
45 pub(crate) fn to_native(&self) -> nativeLevel {
47 Level::Gossip => nativeLevel::Gossip,
48 Level::Trace => nativeLevel::Trace,
49 Level::Debug => nativeLevel::Debug,
50 Level::Info => nativeLevel::Info,
51 Level::Warn => nativeLevel::Warn,
52 Level::Error => nativeLevel::Error,
56 pub(crate) fn into_native(self) -> nativeLevel {
58 Level::Gossip => nativeLevel::Gossip,
59 Level::Trace => nativeLevel::Trace,
60 Level::Debug => nativeLevel::Debug,
61 Level::Info => nativeLevel::Info,
62 Level::Warn => nativeLevel::Warn,
63 Level::Error => nativeLevel::Error,
67 pub(crate) fn from_native(native: &nativeLevel) -> Self {
69 nativeLevel::Gossip => Level::Gossip,
70 nativeLevel::Trace => Level::Trace,
71 nativeLevel::Debug => Level::Debug,
72 nativeLevel::Info => Level::Info,
73 nativeLevel::Warn => Level::Warn,
74 nativeLevel::Error => Level::Error,
78 pub(crate) fn native_into(native: nativeLevel) -> Self {
80 nativeLevel::Gossip => Level::Gossip,
81 nativeLevel::Trace => Level::Trace,
82 nativeLevel::Debug => Level::Debug,
83 nativeLevel::Info => Level::Info,
84 nativeLevel::Warn => Level::Warn,
85 nativeLevel::Error => Level::Error,
89 /// Creates a copy of the Level
91 pub extern "C" fn Level_clone(orig: &Level) -> Level {
95 /// Utility method to constructs a new Gossip-variant Level
96 pub extern "C" fn Level_gossip() -> Level {
99 /// Utility method to constructs a new Trace-variant Level
100 pub extern "C" fn Level_trace() -> Level {
103 /// Utility method to constructs a new Debug-variant Level
104 pub extern "C" fn Level_debug() -> Level {
107 /// Utility method to constructs a new Info-variant Level
108 pub extern "C" fn Level_info() -> Level {
111 /// Utility method to constructs a new Warn-variant Level
112 pub extern "C" fn Level_warn() -> Level {
115 /// Utility method to constructs a new Error-variant Level
116 pub extern "C" fn Level_error() -> Level {
118 /// Checks if two Levels contain equal inner contents.
119 /// This ignores pointers and is_owned flags and looks at the values in fields.
121 pub extern "C" fn Level_eq(a: &Level, b: &Level) -> bool {
122 if &a.to_native() == &b.to_native() { true } else { false }
124 /// Checks if two Levels contain equal inner contents.
126 pub extern "C" fn Level_hash(o: &Level) -> u64 {
127 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
129 let mut hasher = core::hash::SipHasher::new();
130 core::hash::Hash::hash(&o.to_native(), &mut hasher);
131 core::hash::Hasher::finish(&hasher)
133 /// Returns the most verbose logging level.
136 pub extern "C" fn Level_max() -> crate::lightning::util::logger::Level {
137 let mut ret = lightning::util::logger::Level::max();
138 crate::lightning::util::logger::Level::native_into(ret)
142 use lightning::util::logger::Record as nativeRecordImport;
143 pub(crate) type nativeRecord = nativeRecordImport<'static>;
145 /// A Record, unit of logging output with Metadata to enable filtering
146 /// Module_path, file, line to inform on log's source
150 /// A pointer to the opaque Rust object.
152 /// Nearly everywhere, inner must be non-null, however in places where
153 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
154 pub inner: *mut nativeRecord,
155 /// Indicates that this is the only struct which contains the same pointer.
157 /// Rust functions which take ownership of an object provided via an argument require
158 /// this to be true and invalidate the object pointed to by inner.
162 impl Drop for Record {
164 if self.is_owned && !<*mut nativeRecord>::is_null(self.inner) {
165 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
169 /// Frees any resources used by the Record, if is_owned is set and inner is non-NULL.
171 pub extern "C" fn Record_free(this_obj: Record) { }
173 /// Used only if an object of this type is returned as a trait impl by a method
174 pub(crate) extern "C" fn Record_free_void(this_ptr: *mut c_void) {
175 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRecord); }
179 pub(crate) fn get_native_ref(&self) -> &'static nativeRecord {
180 unsafe { &*ObjOps::untweak_ptr(self.inner) }
182 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRecord {
183 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
185 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
186 pub(crate) fn take_inner(mut self) -> *mut nativeRecord {
187 assert!(self.is_owned);
188 let ret = ObjOps::untweak_ptr(self.inner);
189 self.inner = core::ptr::null_mut();
193 /// The verbosity level of the message.
195 pub extern "C" fn Record_get_level(this_ptr: &Record) -> crate::lightning::util::logger::Level {
196 let mut inner_val = &mut this_ptr.get_native_mut_ref().level;
197 crate::lightning::util::logger::Level::from_native(inner_val)
199 /// The verbosity level of the message.
201 pub extern "C" fn Record_set_level(this_ptr: &mut Record, mut val: crate::lightning::util::logger::Level) {
202 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.level = val.into_native();
204 /// The message body.
206 pub extern "C" fn Record_get_args(this_ptr: &Record) -> crate::c_types::Str {
207 let mut inner_val = &mut this_ptr.get_native_mut_ref().args;
208 inner_val.as_str().into()
210 /// The message body.
212 pub extern "C" fn Record_set_args(this_ptr: &mut Record, mut val: crate::c_types::Str) {
213 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.args = val.into_string();
215 /// The module path of the message.
217 pub extern "C" fn Record_get_module_path(this_ptr: &Record) -> crate::c_types::Str {
218 let mut inner_val = &mut this_ptr.get_native_mut_ref().module_path;
221 /// The module path of the message.
223 pub extern "C" fn Record_set_module_path(this_ptr: &mut Record, mut val: crate::c_types::Str) {
224 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.module_path = val.into_str();
226 /// The source file containing the message.
228 pub extern "C" fn Record_get_file(this_ptr: &Record) -> crate::c_types::Str {
229 let mut inner_val = &mut this_ptr.get_native_mut_ref().file;
232 /// The source file containing the message.
234 pub extern "C" fn Record_set_file(this_ptr: &mut Record, mut val: crate::c_types::Str) {
235 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.file = val.into_str();
237 /// The line containing the message.
239 pub extern "C" fn Record_get_line(this_ptr: &Record) -> u32 {
240 let mut inner_val = &mut this_ptr.get_native_mut_ref().line;
243 /// The line containing the message.
245 pub extern "C" fn Record_set_line(this_ptr: &mut Record, mut val: u32) {
246 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.line = val;
248 impl Clone for Record {
249 fn clone(&self) -> Self {
251 inner: if <*mut nativeRecord>::is_null(self.inner) { core::ptr::null_mut() } else {
252 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
258 /// Used only if an object of this type is returned as a trait impl by a method
259 pub(crate) extern "C" fn Record_clone_void(this_ptr: *const c_void) -> *mut c_void {
260 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRecord)).clone() })) as *mut c_void
263 /// Creates a copy of the Record
264 pub extern "C" fn Record_clone(orig: &Record) -> Record {
267 /// A trait encapsulating the operations required of a logger
270 /// An opaque pointer which is passed to your function implementations as an argument.
271 /// This has no meaning in the LDK, and can be NULL or any other value.
272 pub this_arg: *mut c_void,
273 /// Logs the `Record`
274 pub log: extern "C" fn (this_arg: *const c_void, record: &crate::lightning::util::logger::Record),
275 /// Frees any resources associated with this object given its this_arg pointer.
276 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
277 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
279 unsafe impl Send for Logger {}
280 unsafe impl Sync for Logger {}
282 pub(crate) extern "C" fn Logger_clone_fields(orig: &Logger) -> Logger {
284 this_arg: orig.this_arg,
285 log: Clone::clone(&orig.log),
286 free: Clone::clone(&orig.free),
290 use lightning::util::logger::Logger as rustLogger;
291 impl rustLogger for Logger {
292 fn log(&self, mut record: &lightning::util::logger::Record) {
293 (self.log)(self.this_arg, &crate::lightning::util::logger::Record { inner: unsafe { ObjOps::nonnull_ptr_to_inner((record as *const lightning::util::logger::Record<'_, >) as *mut _) }, is_owned: false })
297 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
298 // directly as a Deref trait in higher-level structs:
299 impl core::ops::Deref for Logger {
301 fn deref(&self) -> &Self {
305 /// Calls the free function if one is set
307 pub extern "C" fn Logger_free(this_ptr: Logger) { }
308 impl Drop for Logger {
310 if let Some(f) = self.free {