Merge pull request #1389 from lightning-signer/2022-03-bitcoin

[rust-lightning] / lightning / src / util / logger.rs

diff --git a/lightning/src/util/logger.rs b/lightning/src/util/logger.rs
index 01b024065b29240284f507fd4bb3f9501641fecb..ff576e26ddf4ca485d648c943ad3f36384b30653 100644 (file)
--- a/lightning/src/util/logger.rs
+++ b/lightning/src/util/logger.rs
@@ -17,11 +17,16 @@
 use core::cmp;
 use core::fmt;
 
-static LOG_LEVEL_NAMES: [&'static str; 5] = ["TRACE", "DEBUG", "INFO", "WARN", "ERROR"];
+#[cfg(c_bindings)]
+use prelude::*; // Needed for String
+
+static LOG_LEVEL_NAMES: [&'static str; 6] = ["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"];
 
 /// An enum representing the available verbosity levels of the logger.
 #[derive(Copy, Clone, PartialEq, Eq, Debug, Hash)]
 pub enum Level {
+       /// Designates extremely verbose information, including gossip-induced messages
+       Gossip,
        /// Designates very low priority, often extremely verbose, information
        Trace,
        /// Designates lower priority information
@@ -78,38 +83,51 @@ impl Level {
        /// Returns the most verbose logging level.
        #[inline]
        pub fn max() -> Level {
-               Level::Trace
+               Level::Gossip
        }
 }
 
 /// A Record, unit of logging output with Metadata to enable filtering
 /// Module_path, file, line to inform on log's source
-/// (C-not exported) - we convert to a const char* instead
-#[derive(Clone,Debug)]
+#[derive(Clone, Debug)]
 pub struct Record<'a> {
        /// The verbosity level of the message.
        pub level: Level,
+       #[cfg(not(c_bindings))]
        /// The message body.
        pub args: fmt::Arguments<'a>,
+       #[cfg(c_bindings)]
+       /// The message body.
+       pub args: String,
        /// The module path of the message.
-       pub module_path: &'a str,
+       pub module_path: &'static str,
        /// The source file containing the message.
-       pub file: &'a str,
+       pub file: &'static str,
        /// The line containing the message.
        pub line: u32,
+
+       #[cfg(c_bindings)]
+       /// We don't actually use the lifetime parameter in C bindings (as there is no good way to
+       /// communicate a lifetime to a C, or worse, Java user).
+       _phantom: core::marker::PhantomData<&'a ()>,
 }
 
 impl<'a> Record<'a> {
        /// Returns a new Record.
        /// (C-not exported) as fmt can't be used in C
        #[inline]
-       pub fn new(level: Level, args: fmt::Arguments<'a>, module_path: &'a str, file: &'a str, line: u32) -> Record<'a> {
+       pub fn new(level: Level, args: fmt::Arguments<'a>, module_path: &'static str, file: &'static str, line: u32) -> Record<'a> {
                Record {
                        level,
+                       #[cfg(not(c_bindings))]
                        args,
+                       #[cfg(c_bindings)]
+                       args: format!("{}", args),
                        module_path,
                        file,
-                       line
+                       line,
+                       #[cfg(c_bindings)]
+                       _phantom: core::marker::PhantomData,
                }
        }
 }
@@ -121,6 +139,7 @@ pub trait Logger {
 }
 
 /// Wrapper for logging byte slices in hex format.
+/// (C-not exported) as fmt can't be used in C
 #[doc(hidden)]
 pub struct DebugBytes<'a>(pub &'a [u8]);
 impl<'a> core::fmt::Display for DebugBytes<'a> {
@@ -162,13 +181,14 @@ mod tests {
                        log_info!(self.logger, "This is an info");
                        log_debug!(self.logger, "This is a debug");
                        log_trace!(self.logger, "This is a trace");
+                       log_gossip!(self.logger, "This is a gossip");
                }
        }
 
        #[test]
        fn test_logging_macros() {
                let mut logger = TestLogger::new();
-               logger.enable(Level::Trace);
+               logger.enable(Level::Gossip);
                let logger : Arc<Logger> = Arc::new(logger);
                let wrapper = WrapperLog::new(Arc::clone(&logger));
                wrapper.call_macros();
@@ -188,7 +208,10 @@ mod tests {
                assert!(Level::Debug > Level::Trace);
                assert!(Level::Debug >= Level::Trace);
                assert!(Level::Debug >= Level::Debug);
+               assert!(Level::Trace > Level::Gossip);
+               assert!(Level::Trace >= Level::Gossip);
                assert!(Level::Trace >= Level::Trace);
+               assert!(Level::Gossip >= Level::Gossip);
 
                assert!(Level::Error <= Level::Error);
                assert!(Level::Warn < Level::Error);
@@ -203,5 +226,8 @@ mod tests {
                assert!(Level::Trace < Level::Debug);
                assert!(Level::Trace <= Level::Debug);
                assert!(Level::Trace <= Level::Trace);
+               assert!(Level::Gossip < Level::Trace);
+               assert!(Level::Gossip <= Level::Trace);
+               assert!(Level::Gossip <= Level::Gossip);
        }
 }