X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Futil%2Flogger.rs;h=ff576e26ddf4ca485d648c943ad3f36384b30653;hb=b1cd5a74348ad305ce9cacd30749322651811635;hp=e727723c16dedbc6bb4713b4bd137238884ce0b5;hpb=88fef649b15fa030cb91de76d58346a0bc408834;p=rust-lightning diff --git a/lightning/src/util/logger.rs b/lightning/src/util/logger.rs index e727723c..ff576e26 100644 --- a/lightning/src/util/logger.rs +++ b/lightning/src/util/logger.rs @@ -1,11 +1,11 @@ // Pruned copy of crate rust log, without global logger // https://github.com/rust-lang-nursery/log #7a60286 // -// Licensed under the Apache License, Version 2.0 or the MIT license -// , at your -// option. This file may not be copied, modified, or distributed -// except according to those terms. +// This file is licensed under the Apache License, Version 2.0 or the MIT license +// , at your option. +// You may not use this file except in accordance with one or both of these +// licenses. //! Log traits live here, which are called throughout the library to provide useful information for //! debugging purposes. @@ -14,27 +14,29 @@ //! The second one, client-side by implementing check against Record Level field. //! Each module may have its own Logger or share one. -use std::cmp; -use std::fmt; -use std::sync::Arc; +use core::cmp; +use core::fmt; -static LOG_LEVEL_NAMES: [&'static str; 6] = ["OFF", "ERROR", "WARN", "INFO", "DEBUG", "TRACE"]; +#[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 logger being silent - Off, - /// Designates very serious errors - Error, - /// Designates hazardous situations - Warn, - /// Designates useful information - Info, - /// Designates lower priority information - Debug, + /// Designates extremely verbose information, including gossip-induced messages + Gossip, /// Designates very low priority, often extremely verbose, information Trace, + /// Designates lower priority information + Debug, + /// Designates useful information + Info, + /// Designates hazardous situations + Warn, + /// Designates very serious errors + Error, } impl PartialOrd for Level { @@ -81,53 +83,79 @@ 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 -#[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, } } } /// A trait encapsulating the operations required of a logger -pub trait Logger: Sync + Send { +pub trait Logger { /// Logs the `Record` fn log(&self, record: &Record); } -pub(crate) struct LogHolder<'a> { pub(crate) logger: &'a Arc } +/// 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> { + fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> { + for i in self.0 { + write!(f, "{:02x}", i)?; + } + Ok(()) + } +} #[cfg(test)] mod tests { use util::logger::{Logger, Level}; use util::test_utils::TestLogger; - use std::sync::{Arc}; + use sync::Arc; #[test] fn test_level_show() { @@ -148,20 +176,58 @@ mod tests { } fn call_macros(&self) { - log_error!(self, "This is an error"); - log_warn!(self, "This is a warning"); - log_info!(self, "This is an info"); - log_debug!(self, "This is a debug"); - log_trace!(self, "This is a trace"); + log_error!(self.logger, "This is an error"); + log_warn!(self.logger, "This is a warning"); + 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 = Arc::new(logger); let wrapper = WrapperLog::new(Arc::clone(&logger)); wrapper.call_macros(); } + + #[test] + fn test_log_ordering() { + assert!(Level::Error > Level::Warn); + assert!(Level::Error >= Level::Warn); + assert!(Level::Error >= Level::Error); + assert!(Level::Warn > Level::Info); + assert!(Level::Warn >= Level::Info); + assert!(Level::Warn >= Level::Warn); + assert!(Level::Info > Level::Debug); + assert!(Level::Info >= Level::Debug); + assert!(Level::Info >= Level::Info); + 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); + assert!(Level::Warn <= Level::Error); + assert!(Level::Warn <= Level::Warn); + assert!(Level::Info < Level::Warn); + assert!(Level::Info <= Level::Warn); + assert!(Level::Info <= Level::Info); + assert!(Level::Debug < Level::Info); + assert!(Level::Debug <= Level::Info); + assert!(Level::Debug <= Level::Debug); + 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); + } }