src/liblog/lib.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Utilities for program-wide and customizable logging
  12 //!
  13 //! # Examples
  14 //!
  15 //! ```
  16 //! #[macro_use] extern crate log;
  17 //!
  18 //! fn main() {
  19 //!     debug!("this is a debug {}", "message");
  20 //!     error!("this is printed by default");
  21 //!
  22 //!     if log_enabled!(log::INFO) {
  23 //!         let x = 3i * 4i; // expensive computation
  24 //!         info!("the answer was: {}", x);
  25 //!     }
  26 //! }
  27 //! ```
  28 //!
  29 //! Assumes the binary is `main`:
  30 //!
  31 //! ```{.bash}
  32 //! $ RUST_LOG=error ./main
  33 //! ERROR:main: this is printed by default
  34 //! ```
  35 //!
  36 //! ```{.bash}
  37 //! $ RUST_LOG=info ./main
  38 //! ERROR:main: this is printed by default
  39 //! INFO:main: the answer was: 12
  40 //! ```
  41 //!
  42 //! ```{.bash}
  43 //! $ RUST_LOG=debug ./main
  44 //! DEBUG:main: this is a debug message
  45 //! ERROR:main: this is printed by default
  46 //! INFO:main: the answer was: 12
  47 //! ```
  48 //!
  49 //! You can also set the log level on a per module basis:
  50 //!
  51 //! ```{.bash}
  52 //! $ RUST_LOG=main=info ./main
  53 //! ERROR:main: this is printed by default
  54 //! INFO:main: the answer was: 12
  55 //! ```
  56 //!
  57 //! And enable all logging:
  58 //!
  59 //! ```{.bash}
  60 //! $ RUST_LOG=main ./main
  61 //! DEBUG:main: this is a debug message
  62 //! ERROR:main: this is printed by default
  63 //! INFO:main: the answer was: 12
  64 //! ```
  65 //!
  66 //! # Logging Macros
  67 //!
  68 //! There are five macros that the logging subsystem uses:
  69 //!
  70 //! * `log!(level, ...)` - the generic logging macro, takes a level as a u32 and any
  71 //!                        related `format!` arguments
  72 //! * `debug!(...)` - a macro hard-wired to the log level of `DEBUG`
  73 //! * `info!(...)` - a macro hard-wired to the log level of `INFO`
  74 //! * `warn!(...)` - a macro hard-wired to the log level of `WARN`
  75 //! * `error!(...)` - a macro hard-wired to the log level of `ERROR`
  76 //!
  77 //! All of these macros use the same style of syntax as the `format!` syntax
  78 //! extension. Details about the syntax can be found in the documentation of
  79 //! `std::fmt` along with the Rust tutorial/manual.
  80 //!
  81 //! If you want to check at runtime if a given logging level is enabled (e.g. if the
  82 //! information you would want to log is expensive to produce), you can use the
  83 //! following macro:
  84 //!
  85 //! * `log_enabled!(level)` - returns true if logging of the given level is enabled
  86 //!
  87 //! # Enabling logging
  88 //!
  89 //! Log levels are controlled on a per-module basis, and by default all logging is
  90 //! disabled except for `error!` (a log level of 1). Logging is controlled via the
  91 //! `RUST_LOG` environment variable. The value of this environment variable is a
  92 //! comma-separated list of logging directives. A logging directive is of the form:
  93 //!
  94 //! ```text
  95 //! path::to::module=log_level
  96 //! ```
  97 //!
  98 //! The path to the module is rooted in the name of the crate it was compiled for,
  99 //! so if your program is contained in a file `hello.rs`, for example, to turn on
 100 //! logging for this file you would use a value of `RUST_LOG=hello`.
 101 //! Furthermore, this path is a prefix-search, so all modules nested in the
 102 //! specified module will also have logging enabled.
 103 //!
 104 //! The actual `log_level` is optional to specify. If omitted, all logging will be
 105 //! enabled. If specified, the it must be either a numeric in the range of 1-255, or
 106 //! it must be one of the strings `debug`, `error`, `info`, or `warn`. If a numeric
 107 //! is specified, then all logging less than or equal to that numeral is enabled.
 108 //! For example, if logging level 3 is active, error, warn, and info logs will be
 109 //! printed, but debug will be omitted.
 110 //!
 111 //! As the log level for a module is optional, the module to enable logging for is
 112 //! also optional. If only a `log_level` is provided, then the global log level for
 113 //! all modules is set to this value.
 114 //!
 115 //! Some examples of valid values of `RUST_LOG` are:
 116 //!
 117 //! * `hello` turns on all logging for the 'hello' module
 118 //! * `info` turns on all info logging
 119 //! * `hello=debug` turns on debug logging for 'hello'
 120 //! * `hello=3` turns on info logging for 'hello'
 121 //! * `hello,std::option` turns on hello, and std's option logging
 122 //! * `error,hello=warn` turn on global error logging and also warn for hello
 123 //!
 124 //! # Filtering results
 125 //!
 126 //! A RUST_LOG directive may include a regex filter. The syntax is to append `/`
 127 //! followed by a regex. Each message is checked against the regex, and is only
 128 //! logged if it matches. Note that the matching is done after formatting the log
 129 //! string but before adding any logging meta-data. There is a single filter for all
 130 //! modules.
 131 //!
 132 //! Some examples:
 133 //!
 134 //! * `hello/foo` turns on all logging for the 'hello' module where the log message
 135 //! includes 'foo'.
 136 //! * `info/f.o` turns on all info logging where the log message includes 'foo',
 137 //! 'f1o', 'fao', etc.
 138 //! * `hello=debug/foo*foo` turns on debug logging for 'hello' where the log
 139 //! message includes 'foofoo' or 'fofoo' or 'fooooooofoo', etc.
 140 //! * `error,hello=warn/[0-9] scopes` turn on global error logging and also warn for
 141 //!  hello. In both cases the log message must include a single digit number
 142 //!  followed by 'scopes'
 143 //!
 144 //! # Performance and Side Effects
 145 //!
 146 //! Each of these macros will expand to code similar to:
 147 //!
 148 //! ```rust,ignore
 149 //! if log_level <= my_module_log_level() {
 150 //!     ::log::log(log_level, format!(...));
 151 //! }
 152 //! ```
 153 //!
 154 //! What this means is that each of these macros are very cheap at runtime if
 155 //! they're turned off (just a load and an integer comparison). This also means that
 156 //! if logging is disabled, none of the components of the log will be executed.
 157
 158 #![crate_name = "log"]
 159 #![experimental = "use the crates.io `log` library instead"]
 160 #![crate_type = "rlib"]
 161 #![crate_type = "dylib"]
 162 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
 163        html_favicon_url = "http://www.rust-lang.org/favicon.ico",
 164        html_root_url = "http://doc.rust-lang.org/nightly/",
 165        html_playground_url = "http://play.rust-lang.org/")]
 166 #![feature(macro_rules, unboxed_closures, slicing_syntax)]
 167 #![deny(missing_docs)]
 168
 169 extern crate regex;
 170
 171 use std::cell::RefCell;
 172 use std::fmt;
 173 use std::io::LineBufferedWriter;
 174 use std::io;
 175 use std::mem;
 176 use std::os;
 177 use std::rt;
 178 use std::slice;
 179 use std::sync::{Once, ONCE_INIT};
 180
 181 use regex::Regex;
 182
 183 use directive::LOG_LEVEL_NAMES;
 184
 185 #[cfg_attr(stage0, macro_escape)]
 186 #[cfg_attr(not(stage0), macro_use)]
 187 pub mod macros;
 188
 189 mod directive;
 190
 191 /// Maximum logging level of a module that can be specified. Common logging
 192 /// levels are found in the DEBUG/INFO/WARN/ERROR constants.
 193 pub const MAX_LOG_LEVEL: u32 = 255;
 194
 195 /// The default logging level of a crate if no other is specified.
 196 const DEFAULT_LOG_LEVEL: u32 = 1;
 197
 198 /// An unsafe constant that is the maximum logging level of any module
 199 /// specified. This is the first line of defense to determining whether a
 200 /// logging statement should be run.
 201 static mut LOG_LEVEL: u32 = MAX_LOG_LEVEL;
 202
 203 static mut DIRECTIVES: *const Vec<directive::LogDirective> =
 204     0 as *const Vec<directive::LogDirective>;
 205
 206 /// Optional regex filter.
 207 static mut FILTER: *const Regex = 0 as *const _;
 208
 209 /// Debug log level
 210 pub const DEBUG: u32 = 4;
 211 /// Info log level
 212 pub const INFO: u32 = 3;
 213 /// Warn log level
 214 pub const WARN: u32 = 2;
 215 /// Error log level
 216 pub const ERROR: u32 = 1;
 217
 218 thread_local! {
 219     static LOCAL_LOGGER: RefCell<Option<Box<Logger + Send>>> = {
 220         RefCell::new(None)
 221     }
 222 }
 223
 224 /// A trait used to represent an interface to a task-local logger. Each task
 225 /// can have its own custom logger which can respond to logging messages
 226 /// however it likes.
 227 pub trait Logger {
 228     /// Logs a single message described by the `record`.
 229     fn log(&mut self, record: &LogRecord);
 230 }
 231
 232 struct DefaultLogger {
 233     handle: LineBufferedWriter<io::stdio::StdWriter>,
 234 }
 235
 236 /// Wraps the log level with fmt implementations.
 237 #[derive(Copy, PartialEq, PartialOrd)]
 238 pub struct LogLevel(pub u32);
 239
 240 impl fmt::Show for LogLevel {
 241     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
 242         let LogLevel(level) = *self;
 243         match LOG_LEVEL_NAMES.get(level as uint - 1) {
 244             Some(name) => name.fmt(fmt),
 245             None => level.fmt(fmt)
 246         }
 247     }
 248 }
 249
 250 impl Logger for DefaultLogger {
 251     fn log(&mut self, record: &LogRecord) {
 252         match writeln!(&mut self.handle,
 253                        "{}:{}: {}",
 254                        record.level,
 255                        record.module_path,
 256                        record.args) {
 257             Err(e) => panic!("failed to log: {}", e),
 258             Ok(()) => {}
 259         }
 260     }
 261 }
 262
 263 impl Drop for DefaultLogger {
 264     fn drop(&mut self) {
 265         // FIXME(#12628): is panicking the right thing to do?
 266         match self.handle.flush() {
 267             Err(e) => panic!("failed to flush a logger: {}", e),
 268             Ok(()) => {}
 269         }
 270     }
 271 }
 272
 273 /// This function is called directly by the compiler when using the logging
 274 /// macros. This function does not take into account whether the log level
 275 /// specified is active or not, it will always log something if this method is
 276 /// called.
 277 ///
 278 /// It is not recommended to call this function directly, rather it should be
 279 /// invoked through the logging family of macros.
 280 #[doc(hidden)]
 281 pub fn log(level: u32, loc: &'static LogLocation, args: fmt::Arguments) {
 282     // Test the literal string from args against the current filter, if there
 283     // is one.
 284     match unsafe { FILTER.as_ref() } {
 285         Some(filter) if !filter.is_match(args.to_string()[]) => return,
 286         _ => {}
 287     }
 288
 289     // Completely remove the local logger from TLS in case anyone attempts to
 290     // frob the slot while we're doing the logging. This will destroy any logger
 291     // set during logging.
 292     let mut logger = LOCAL_LOGGER.with(|s| {
 293         s.borrow_mut().take()
 294     }).unwrap_or_else(|| {
 295         box DefaultLogger { handle: io::stderr() } as Box<Logger + Send>
 296     });
 297     logger.log(&LogRecord {
 298         level: LogLevel(level),
 299         args: args,
 300         file: loc.file,
 301         module_path: loc.module_path,
 302         line: loc.line,
 303     });
 304     set_logger(logger);
 305 }
 306
 307 /// Getter for the global log level. This is a function so that it can be called
 308 /// safely
 309 #[doc(hidden)]
 310 #[inline(always)]
 311 pub fn log_level() -> u32 { unsafe { LOG_LEVEL } }
 312
 313 /// Replaces the task-local logger with the specified logger, returning the old
 314 /// logger.
 315 pub fn set_logger(logger: Box<Logger + Send>) -> Option<Box<Logger + Send>> {
 316     let mut l = Some(logger);
 317     LOCAL_LOGGER.with(|slot| {
 318         mem::replace(&mut *slot.borrow_mut(), l.take())
 319     })
 320 }
 321
 322 /// A LogRecord is created by the logging macros, and passed as the only
 323 /// argument to Loggers.
 324 #[derive(Show)]
 325 pub struct LogRecord<'a> {
 326
 327     /// The module path of where the LogRecord originated.
 328     pub module_path: &'a str,
 329
 330     /// The LogLevel of this record.
 331     pub level: LogLevel,
 332
 333     /// The arguments from the log line.
 334     pub args: fmt::Arguments<'a>,
 335
 336     /// The file of where the LogRecord originated.
 337     pub file: &'a str,
 338
 339     /// The line number of where the LogRecord originated.
 340     pub line: uint,
 341 }
 342
 343 #[doc(hidden)]
 344 #[derive(Copy)]
 345 pub struct LogLocation {
 346     pub module_path: &'static str,
 347     pub file: &'static str,
 348     pub line: uint,
 349 }
 350
 351 /// Tests whether a given module's name is enabled for a particular level of
 352 /// logging. This is the second layer of defense about determining whether a
 353 /// module's log statement should be emitted or not.
 354 #[doc(hidden)]
 355 pub fn mod_enabled(level: u32, module: &str) -> bool {
 356     static INIT: Once = ONCE_INIT;
 357     INIT.call_once(init);
 358
 359     // It's possible for many threads are in this function, only one of them
 360     // will perform the global initialization, but all of them will need to check
 361     // again to whether they should really be here or not. Hence, despite this
 362     // check being expanded manually in the logging macro, this function checks
 363     // the log level again.
 364     if level > unsafe { LOG_LEVEL } { return false }
 365
 366     // This assertion should never get tripped unless we're in an at_exit
 367     // handler after logging has been torn down and a logging attempt was made.
 368     assert!(unsafe { !DIRECTIVES.is_null() });
 369
 370     enabled(level, module, unsafe { (*DIRECTIVES).iter() })
 371 }
 372
 373 fn enabled(level: u32,
 374            module: &str,
 375            iter: slice::Iter<directive::LogDirective>)
 376            -> bool {
 377     // Search for the longest match, the vector is assumed to be pre-sorted.
 378     for directive in iter.rev() {
 379         match directive.name {
 380             Some(ref name) if !module.starts_with(name[]) => {},
 381             Some(..) | None => {
 382                 return level <= directive.level
 383             }
 384         }
 385     }
 386     level <= DEFAULT_LOG_LEVEL
 387 }
 388
 389 /// Initialize logging for the current process.
 390 ///
 391 /// This is not threadsafe at all, so initialization is performed through a
 392 /// `Once` primitive (and this function is called from that primitive).
 393 fn init() {
 394     let (mut directives, filter) = match os::getenv("RUST_LOG") {
 395         Some(spec) => directive::parse_logging_spec(spec[]),
 396         None => (Vec::new(), None),
 397     };
 398
 399     // Sort the provided directives by length of their name, this allows a
 400     // little more efficient lookup at runtime.
 401     directives.sort_by(|a, b| {
 402         let alen = a.name.as_ref().map(|a| a.len()).unwrap_or(0);
 403         let blen = b.name.as_ref().map(|b| b.len()).unwrap_or(0);
 404         alen.cmp(&blen)
 405     });
 406
 407     let max_level = {
 408         let max = directives.iter().max_by(|d| d.level);
 409         max.map(|d| d.level).unwrap_or(DEFAULT_LOG_LEVEL)
 410     };
 411
 412     unsafe {
 413         LOG_LEVEL = max_level;
 414
 415         assert!(FILTER.is_null());
 416         match filter {
 417             Some(f) => FILTER = mem::transmute(box f),
 418             None => {}
 419         }
 420
 421         assert!(DIRECTIVES.is_null());
 422         DIRECTIVES = mem::transmute(box directives);
 423
 424         // Schedule the cleanup for the globals for when the runtime exits.
 425         rt::at_exit(move |:| {
 426             assert!(!DIRECTIVES.is_null());
 427             let _directives: Box<Vec<directive::LogDirective>> =
 428                 mem::transmute(DIRECTIVES);
 429             DIRECTIVES = 0 as *const Vec<directive::LogDirective>;
 430
 431             if !FILTER.is_null() {
 432                 let _filter: Box<Regex> = mem::transmute(FILTER);
 433                 FILTER = 0 as *const _;
 434             }
 435         });
 436     }
 437 }
 438
 439 #[cfg(test)]
 440 mod tests {
 441     use super::enabled;
 442     use directive::LogDirective;
 443
 444     #[test]
 445     fn match_full_path() {
 446         let dirs = [
 447             LogDirective {
 448                 name: Some("crate2".to_string()),
 449                 level: 3
 450             },
 451             LogDirective {
 452                 name: Some("crate1::mod1".to_string()),
 453                 level: 2
 454             }
 455         ];
 456         assert!(enabled(2, "crate1::mod1", dirs.iter()));
 457         assert!(!enabled(3, "crate1::mod1", dirs.iter()));
 458         assert!(enabled(3, "crate2", dirs.iter()));
 459         assert!(!enabled(4, "crate2", dirs.iter()));
 460     }
 461
 462     #[test]
 463     fn no_match() {
 464         let dirs = [
 465             LogDirective { name: Some("crate2".to_string()), level: 3 },
 466             LogDirective { name: Some("crate1::mod1".to_string()), level: 2 }
 467         ];
 468         assert!(!enabled(2, "crate3", dirs.iter()));
 469     }
 470
 471     #[test]
 472     fn match_beginning() {
 473         let dirs = [
 474             LogDirective { name: Some("crate2".to_string()), level: 3 },
 475             LogDirective { name: Some("crate1::mod1".to_string()), level: 2 }
 476         ];
 477         assert!(enabled(3, "crate2::mod1", dirs.iter()));
 478     }
 479
 480     #[test]
 481     fn match_beginning_longest_match() {
 482         let dirs = [
 483             LogDirective { name: Some("crate2".to_string()), level: 3 },
 484             LogDirective { name: Some("crate2::mod".to_string()), level: 4 },
 485             LogDirective { name: Some("crate1::mod1".to_string()), level: 2 }
 486         ];
 487         assert!(enabled(4, "crate2::mod1", dirs.iter()));
 488         assert!(!enabled(4, "crate2", dirs.iter()));
 489     }
 490
 491     #[test]
 492     fn match_default() {
 493         let dirs = [
 494             LogDirective { name: None, level: 3 },
 495             LogDirective { name: Some("crate1::mod1".to_string()), level: 2 }
 496         ];
 497         assert!(enabled(2, "crate1::mod1", dirs.iter()));
 498         assert!(enabled(3, "crate2::mod2", dirs.iter()));
 499     }
 500
 501     #[test]
 502     fn zero_level() {
 503         let dirs = [
 504             LogDirective { name: None, level: 3 },
 505             LogDirective { name: Some("crate1::mod1".to_string()), level: 0 }
 506         ];
 507         assert!(!enabled(1, "crate1::mod1", dirs.iter()));
 508         assert!(enabled(3, "crate2::mod2", dirs.iter()));
 509     }
 510 }