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 = 3 * 4; // 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 string filter. The syntax is to append
 127 //! `/` followed by a string. Each message is checked against the string and is
 128 //! only logged if it contains the string. Note that the matching is done after
 129 //! formatting the log string but before adding any logging meta-data. There is
 130 //! a single filter for all 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 #![unstable(feature = "rustc_private",
 160             reason = "use the crates.io `log` library instead")]
 161 #![staged_api]
 162 #![crate_type = "rlib"]
 163 #![crate_type = "dylib"]
 164 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
 165        html_favicon_url = "http://www.rust-lang.org/favicon.ico",
 166        html_root_url = "http://doc.rust-lang.org/nightly/",
 167        html_playground_url = "http://play.rust-lang.org/")]
 168 #![deny(missing_docs)]
 169
 170 #![feature(staged_api)]
 171 #![feature(box_syntax)]
 172 #![feature(int_uint)]
 173 #![feature(core)]
 174 #![feature(old_io)]
 175 #![feature(std_misc)]
 176 #![feature(env)]
 177
 178 use std::cell::RefCell;
 179 use std::fmt;
 180 use std::old_io::LineBufferedWriter;
 181 use std::old_io;
 182 use std::mem;
 183 use std::env;
 184 use std::ptr;
 185 use std::rt;
 186 use std::slice;
 187 use std::sync::{Once, ONCE_INIT};
 188
 189 use directive::LOG_LEVEL_NAMES;
 190
 191 #[macro_use]
 192 pub mod macros;
 193
 194 mod directive;
 195
 196 /// Maximum logging level of a module that can be specified. Common logging
 197 /// levels are found in the DEBUG/INFO/WARN/ERROR constants.
 198 pub const MAX_LOG_LEVEL: u32 = 255;
 199
 200 /// The default logging level of a crate if no other is specified.
 201 const DEFAULT_LOG_LEVEL: u32 = 1;
 202
 203 /// An unsafe constant that is the maximum logging level of any module
 204 /// specified. This is the first line of defense to determining whether a
 205 /// logging statement should be run.
 206 static mut LOG_LEVEL: u32 = MAX_LOG_LEVEL;
 207
 208 static mut DIRECTIVES: *const Vec<directive::LogDirective> =
 209     0 as *const Vec<directive::LogDirective>;
 210
 211 /// Optional filter.
 212 static mut FILTER: *const String = 0 as *const _;
 213
 214 /// Debug log level
 215 pub const DEBUG: u32 = 4;
 216 /// Info log level
 217 pub const INFO: u32 = 3;
 218 /// Warn log level
 219 pub const WARN: u32 = 2;
 220 /// Error log level
 221 pub const ERROR: u32 = 1;
 222
 223 thread_local! {
 224     static LOCAL_LOGGER: RefCell<Option<Box<Logger + Send>>> = {
 225         RefCell::new(None)
 226     }
 227 }
 228
 229 /// A trait used to represent an interface to a task-local logger. Each task
 230 /// can have its own custom logger which can respond to logging messages
 231 /// however it likes.
 232 pub trait Logger {
 233     /// Logs a single message described by the `record`.
 234     fn log(&mut self, record: &LogRecord);
 235 }
 236
 237 struct DefaultLogger {
 238     handle: LineBufferedWriter<old_io::stdio::StdWriter>,
 239 }
 240
 241 /// Wraps the log level with fmt implementations.
 242 #[derive(Copy, PartialEq, PartialOrd, Debug)]
 243 pub struct LogLevel(pub u32);
 244
 245 impl fmt::Display for LogLevel {
 246     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
 247         let LogLevel(level) = *self;
 248         match LOG_LEVEL_NAMES.get(level as uint - 1) {
 249             Some(ref name) => fmt::Display::fmt(name, fmt),
 250             None => fmt::Display::fmt(&level, fmt)
 251         }
 252     }
 253 }
 254
 255 impl Logger for DefaultLogger {
 256     fn log(&mut self, record: &LogRecord) {
 257         match writeln!(&mut self.handle,
 258                        "{}:{}: {}",
 259                        record.level,
 260                        record.module_path,
 261                        record.args) {
 262             Err(e) => panic!("failed to log: {:?}", e),
 263             Ok(()) => {}
 264         }
 265     }
 266 }
 267
 268 impl Drop for DefaultLogger {
 269     fn drop(&mut self) {
 270         // FIXME(#12628): is panicking the right thing to do?
 271         match self.handle.flush() {
 272             Err(e) => panic!("failed to flush a logger: {:?}", e),
 273             Ok(()) => {}
 274         }
 275     }
 276 }
 277
 278 /// This function is called directly by the compiler when using the logging
 279 /// macros. This function does not take into account whether the log level
 280 /// specified is active or not, it will always log something if this method is
 281 /// called.
 282 ///
 283 /// It is not recommended to call this function directly, rather it should be
 284 /// invoked through the logging family of macros.
 285 #[doc(hidden)]
 286 pub fn log(level: u32, loc: &'static LogLocation, args: fmt::Arguments) {
 287     // Test the literal string from args against the current filter, if there
 288     // is one.
 289     match unsafe { FILTER.as_ref() } {
 290         Some(filter) if !args.to_string().contains(&filter[..]) => return,
 291         _ => {}
 292     }
 293
 294     // Completely remove the local logger from TLS in case anyone attempts to
 295     // frob the slot while we're doing the logging. This will destroy any logger
 296     // set during logging.
 297     let mut logger = LOCAL_LOGGER.with(|s| {
 298         s.borrow_mut().take()
 299     }).unwrap_or_else(|| {
 300         box DefaultLogger { handle: old_io::stderr() } as Box<Logger + Send>
 301     });
 302     logger.log(&LogRecord {
 303         level: LogLevel(level),
 304         args: args,
 305         file: loc.file,
 306         module_path: loc.module_path,
 307         line: loc.line,
 308     });
 309     set_logger(logger);
 310 }
 311
 312 /// Getter for the global log level. This is a function so that it can be called
 313 /// safely
 314 #[doc(hidden)]
 315 #[inline(always)]
 316 pub fn log_level() -> u32 { unsafe { LOG_LEVEL } }
 317
 318 /// Replaces the task-local logger with the specified logger, returning the old
 319 /// logger.
 320 pub fn set_logger(logger: Box<Logger + Send>) -> Option<Box<Logger + Send>> {
 321     let mut l = Some(logger);
 322     LOCAL_LOGGER.with(|slot| {
 323         mem::replace(&mut *slot.borrow_mut(), l.take())
 324     })
 325 }
 326
 327 /// A LogRecord is created by the logging macros, and passed as the only
 328 /// argument to Loggers.
 329 #[derive(Debug)]
 330 pub struct LogRecord<'a> {
 331
 332     /// The module path of where the LogRecord originated.
 333     pub module_path: &'a str,
 334
 335     /// The LogLevel of this record.
 336     pub level: LogLevel,
 337
 338     /// The arguments from the log line.
 339     pub args: fmt::Arguments<'a>,
 340
 341     /// The file of where the LogRecord originated.
 342     pub file: &'a str,
 343
 344     /// The line number of where the LogRecord originated.
 345     pub line: uint,
 346 }
 347
 348 #[doc(hidden)]
 349 #[derive(Copy)]
 350 pub struct LogLocation {
 351     pub module_path: &'static str,
 352     pub file: &'static str,
 353     pub line: uint,
 354 }
 355
 356 /// Tests whether a given module's name is enabled for a particular level of
 357 /// logging. This is the second layer of defense about determining whether a
 358 /// module's log statement should be emitted or not.
 359 #[doc(hidden)]
 360 pub fn mod_enabled(level: u32, module: &str) -> bool {
 361     static INIT: Once = ONCE_INIT;
 362     INIT.call_once(init);
 363
 364     // It's possible for many threads are in this function, only one of them
 365     // will perform the global initialization, but all of them will need to check
 366     // again to whether they should really be here or not. Hence, despite this
 367     // check being expanded manually in the logging macro, this function checks
 368     // the log level again.
 369     if level > unsafe { LOG_LEVEL } { return false }
 370
 371     // This assertion should never get tripped unless we're in an at_exit
 372     // handler after logging has been torn down and a logging attempt was made.
 373     assert!(unsafe { !DIRECTIVES.is_null() });
 374
 375     enabled(level, module, unsafe { (*DIRECTIVES).iter() })
 376 }
 377
 378 fn enabled(level: u32,
 379            module: &str,
 380            iter: slice::Iter<directive::LogDirective>)
 381            -> bool {
 382     // Search for the longest match, the vector is assumed to be pre-sorted.
 383     for directive in iter.rev() {
 384         match directive.name {
 385             Some(ref name) if !module.starts_with(&name[..]) => {},
 386             Some(..) | None => {
 387                 return level <= directive.level
 388             }
 389         }
 390     }
 391     level <= DEFAULT_LOG_LEVEL
 392 }
 393
 394 /// Initialize logging for the current process.
 395 ///
 396 /// This is not threadsafe at all, so initialization is performed through a
 397 /// `Once` primitive (and this function is called from that primitive).
 398 fn init() {
 399     let (mut directives, filter) = match env::var("RUST_LOG") {
 400         Ok(spec) => directive::parse_logging_spec(&spec[..]),
 401         Err(..) => (Vec::new(), None),
 402     };
 403
 404     // Sort the provided directives by length of their name, this allows a
 405     // little more efficient lookup at runtime.
 406     directives.sort_by(|a, b| {
 407         let alen = a.name.as_ref().map(|a| a.len()).unwrap_or(0);
 408         let blen = b.name.as_ref().map(|b| b.len()).unwrap_or(0);
 409         alen.cmp(&blen)
 410     });
 411
 412     let max_level = {
 413         let max = directives.iter().max_by(|d| d.level);
 414         max.map(|d| d.level).unwrap_or(DEFAULT_LOG_LEVEL)
 415     };
 416
 417     unsafe {
 418         LOG_LEVEL = max_level;
 419
 420         assert!(FILTER.is_null());
 421         match filter {
 422             Some(f) => FILTER = mem::transmute(box f),
 423             None => {}
 424         }
 425
 426         assert!(DIRECTIVES.is_null());
 427         DIRECTIVES = mem::transmute(box directives);
 428
 429         // Schedule the cleanup for the globals for when the runtime exits.
 430         rt::at_exit(move || {
 431             assert!(!DIRECTIVES.is_null());
 432             let _directives: Box<Vec<directive::LogDirective>> =
 433                 mem::transmute(DIRECTIVES);
 434             DIRECTIVES = ptr::null();
 435
 436             if !FILTER.is_null() {
 437                 let _filter: Box<String> = mem::transmute(FILTER);
 438                 FILTER = 0 as *const _;
 439             }
 440         });
 441     }
 442 }
 443
 444 #[cfg(test)]
 445 mod tests {
 446     use super::enabled;
 447     use directive::LogDirective;
 448
 449     #[test]
 450     fn match_full_path() {
 451         let dirs = [
 452             LogDirective {
 453                 name: Some("crate2".to_string()),
 454                 level: 3
 455             },
 456             LogDirective {
 457                 name: Some("crate1::mod1".to_string()),
 458                 level: 2
 459             }
 460         ];
 461         assert!(enabled(2, "crate1::mod1", dirs.iter()));
 462         assert!(!enabled(3, "crate1::mod1", dirs.iter()));
 463         assert!(enabled(3, "crate2", dirs.iter()));
 464         assert!(!enabled(4, "crate2", dirs.iter()));
 465     }
 466
 467     #[test]
 468     fn no_match() {
 469         let dirs = [
 470             LogDirective { name: Some("crate2".to_string()), level: 3 },
 471             LogDirective { name: Some("crate1::mod1".to_string()), level: 2 }
 472         ];
 473         assert!(!enabled(2, "crate3", dirs.iter()));
 474     }
 475
 476     #[test]
 477     fn match_beginning() {
 478         let dirs = [
 479             LogDirective { name: Some("crate2".to_string()), level: 3 },
 480             LogDirective { name: Some("crate1::mod1".to_string()), level: 2 }
 481         ];
 482         assert!(enabled(3, "crate2::mod1", dirs.iter()));
 483     }
 484
 485     #[test]
 486     fn match_beginning_longest_match() {
 487         let dirs = [
 488             LogDirective { name: Some("crate2".to_string()), level: 3 },
 489             LogDirective { name: Some("crate2::mod".to_string()), level: 4 },
 490             LogDirective { name: Some("crate1::mod1".to_string()), level: 2 }
 491         ];
 492         assert!(enabled(4, "crate2::mod1", dirs.iter()));
 493         assert!(!enabled(4, "crate2", dirs.iter()));
 494     }
 495
 496     #[test]
 497     fn match_default() {
 498         let dirs = [
 499             LogDirective { name: None, level: 3 },
 500             LogDirective { name: Some("crate1::mod1".to_string()), level: 2 }
 501         ];
 502         assert!(enabled(2, "crate1::mod1", dirs.iter()));
 503         assert!(enabled(3, "crate2::mod2", dirs.iter()));
 504     }
 505
 506     #[test]
 507     fn zero_level() {
 508         let dirs = [
 509             LogDirective { name: None, level: 3 },
 510             LogDirective { name: Some("crate1::mod1".to_string()), level: 0 }
 511         ];
 512         assert!(!enabled(1, "crate1::mod1", dirs.iter()));
 513         assert!(enabled(3, "crate2::mod2", dirs.iter()));
 514     }
 515 }