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 std::str::FromStr;
18 use core::convert::Infallible;
19 use bitcoin::hashes::Hash;
20 use crate::c_types::*;
22 /// An enum representing the available verbosity levels of the logger.
27 /// Designates very low priority, often extremely verbose, information
29 /// Designates lower priority information
31 /// Designates useful information
33 /// Designates hazardous situations
35 /// Designates very serious errors
38 use lightning::util::logger::Level as nativeLevel;
41 pub(crate) fn to_native(&self) -> nativeLevel {
43 Level::Trace => nativeLevel::Trace,
44 Level::Debug => nativeLevel::Debug,
45 Level::Info => nativeLevel::Info,
46 Level::Warn => nativeLevel::Warn,
47 Level::Error => nativeLevel::Error,
51 pub(crate) fn into_native(self) -> nativeLevel {
53 Level::Trace => nativeLevel::Trace,
54 Level::Debug => nativeLevel::Debug,
55 Level::Info => nativeLevel::Info,
56 Level::Warn => nativeLevel::Warn,
57 Level::Error => nativeLevel::Error,
61 pub(crate) fn from_native(native: &nativeLevel) -> Self {
63 nativeLevel::Trace => Level::Trace,
64 nativeLevel::Debug => Level::Debug,
65 nativeLevel::Info => Level::Info,
66 nativeLevel::Warn => Level::Warn,
67 nativeLevel::Error => Level::Error,
71 pub(crate) fn native_into(native: nativeLevel) -> Self {
73 nativeLevel::Trace => Level::Trace,
74 nativeLevel::Debug => Level::Debug,
75 nativeLevel::Info => Level::Info,
76 nativeLevel::Warn => Level::Warn,
77 nativeLevel::Error => Level::Error,
81 /// Creates a copy of the Level
83 pub extern "C" fn Level_clone(orig: &Level) -> Level {
87 /// Utility method to constructs a new Trace-variant Level
88 pub extern "C" fn Level_trace() -> Level {
91 /// Utility method to constructs a new Debug-variant Level
92 pub extern "C" fn Level_debug() -> Level {
95 /// Utility method to constructs a new Info-variant Level
96 pub extern "C" fn Level_info() -> Level {
99 /// Utility method to constructs a new Warn-variant Level
100 pub extern "C" fn Level_warn() -> Level {
103 /// Utility method to constructs a new Error-variant Level
104 pub extern "C" fn Level_error() -> Level {
106 /// Checks if two Levels contain equal inner contents.
107 /// This ignores pointers and is_owned flags and looks at the values in fields.
109 pub extern "C" fn Level_eq(a: &Level, b: &Level) -> bool {
110 if &a.to_native() == &b.to_native() { true } else { false }
112 /// Checks if two Levels contain equal inner contents.
114 pub extern "C" fn Level_hash(o: &Level) -> u64 {
115 // Note that we'd love to use std::collections::hash_map::DefaultHasher but it's not in core
117 let mut hasher = core::hash::SipHasher::new();
118 std::hash::Hash::hash(&o.to_native(), &mut hasher);
119 std::hash::Hasher::finish(&hasher)
121 /// Returns the most verbose logging level.
124 pub extern "C" fn Level_max() -> crate::lightning::util::logger::Level {
125 let mut ret = lightning::util::logger::Level::max();
126 crate::lightning::util::logger::Level::native_into(ret)
130 use lightning::util::logger::Record as nativeRecordImport;
131 pub(crate) type nativeRecord = nativeRecordImport<'static>;
133 /// A Record, unit of logging output with Metadata to enable filtering
134 /// Module_path, file, line to inform on log's source
138 /// A pointer to the opaque Rust object.
140 /// Nearly everywhere, inner must be non-null, however in places where
141 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
142 pub inner: *mut nativeRecord,
143 /// Indicates that this is the only struct which contains the same pointer.
145 /// Rust functions which take ownership of an object provided via an argument require
146 /// this to be true and invalidate the object pointed to by inner.
150 impl Drop for Record {
152 if self.is_owned && !<*mut nativeRecord>::is_null(self.inner) {
153 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
157 /// Frees any resources used by the Record, if is_owned is set and inner is non-NULL.
159 pub extern "C" fn Record_free(this_obj: Record) { }
161 /// Used only if an object of this type is returned as a trait impl by a method
162 pub(crate) extern "C" fn Record_free_void(this_ptr: *mut c_void) {
163 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRecord); }
167 pub(crate) fn get_native_ref(&self) -> &'static nativeRecord {
168 unsafe { &*ObjOps::untweak_ptr(self.inner) }
170 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRecord {
171 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
173 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
174 pub(crate) fn take_inner(mut self) -> *mut nativeRecord {
175 assert!(self.is_owned);
176 let ret = ObjOps::untweak_ptr(self.inner);
177 self.inner = std::ptr::null_mut();
181 /// The verbosity level of the message.
183 pub extern "C" fn Record_get_level(this_ptr: &Record) -> crate::lightning::util::logger::Level {
184 let mut inner_val = &mut this_ptr.get_native_mut_ref().level;
185 crate::lightning::util::logger::Level::from_native(inner_val)
187 /// The verbosity level of the message.
189 pub extern "C" fn Record_set_level(this_ptr: &mut Record, mut val: crate::lightning::util::logger::Level) {
190 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.level = val.into_native();
192 /// The message body.
194 pub extern "C" fn Record_get_args(this_ptr: &Record) -> crate::c_types::Str {
195 let mut inner_val = &mut this_ptr.get_native_mut_ref().args;
196 inner_val.as_str().into()
198 /// The message body.
200 pub extern "C" fn Record_set_args(this_ptr: &mut Record, mut val: crate::c_types::Str) {
201 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.args = val.into_string();
203 /// The module path of the message.
205 pub extern "C" fn Record_get_module_path(this_ptr: &Record) -> crate::c_types::Str {
206 let mut inner_val = &mut this_ptr.get_native_mut_ref().module_path;
209 /// The module path of the message.
211 pub extern "C" fn Record_set_module_path(this_ptr: &mut Record, mut val: crate::c_types::Str) {
212 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.module_path = val.into_str();
214 /// The source file containing the message.
216 pub extern "C" fn Record_get_file(this_ptr: &Record) -> crate::c_types::Str {
217 let mut inner_val = &mut this_ptr.get_native_mut_ref().file;
220 /// The source file containing the message.
222 pub extern "C" fn Record_set_file(this_ptr: &mut Record, mut val: crate::c_types::Str) {
223 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.file = val.into_str();
225 /// The line containing the message.
227 pub extern "C" fn Record_get_line(this_ptr: &Record) -> u32 {
228 let mut inner_val = &mut this_ptr.get_native_mut_ref().line;
231 /// The line containing the message.
233 pub extern "C" fn Record_set_line(this_ptr: &mut Record, mut val: u32) {
234 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.line = val;
236 impl Clone for Record {
237 fn clone(&self) -> Self {
239 inner: if <*mut nativeRecord>::is_null(self.inner) { std::ptr::null_mut() } else {
240 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
246 /// Used only if an object of this type is returned as a trait impl by a method
247 pub(crate) extern "C" fn Record_clone_void(this_ptr: *const c_void) -> *mut c_void {
248 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRecord)).clone() })) as *mut c_void
251 /// Creates a copy of the Record
252 pub extern "C" fn Record_clone(orig: &Record) -> Record {
255 /// A trait encapsulating the operations required of a logger
258 /// An opaque pointer which is passed to your function implementations as an argument.
259 /// This has no meaning in the LDK, and can be NULL or any other value.
260 pub this_arg: *mut c_void,
261 /// Logs the `Record`
262 pub log: extern "C" fn (this_arg: *const c_void, record: &crate::lightning::util::logger::Record),
263 /// Frees any resources associated with this object given its this_arg pointer.
264 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
265 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
267 unsafe impl Send for Logger {}
268 unsafe impl Sync for Logger {}
270 pub(crate) extern "C" fn Logger_clone_fields(orig: &Logger) -> Logger {
272 this_arg: orig.this_arg,
273 log: Clone::clone(&orig.log),
274 free: Clone::clone(&orig.free),
278 use lightning::util::logger::Logger as rustLogger;
279 impl rustLogger for Logger {
280 fn log(&self, mut record: &lightning::util::logger::Record) {
281 (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 })
285 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
286 // directly as a Deref trait in higher-level structs:
287 impl std::ops::Deref for Logger {
289 fn deref(&self) -> &Self {
293 /// Calls the free function if one is set
295 pub extern "C" fn Logger_free(this_ptr: Logger) { }
296 impl Drop for Logger {
298 if let Some(f) = self.free {