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 /*!
  12
  13 Utilities for program-wide and customizable logging
  14
  15 ## Example
  16
  17 ```
  18 #![feature(phase)]
  19 #[phase(syntax, link)] extern crate log;
  20
  21 fn main() {
  22     debug!("this is a debug {}", "message");
  23     error!("this is printed by default");
  24
  25     if log_enabled!(log::INFO) {
  26         let x = 3 * 4; // expensive computation
  27         info!("the answer was: {}", x);
  28     }
  29 }
  30 ```
  31
  32 ## Logging Macros
  33
  34 There are five macros that the logging subsystem uses:
  35
  36 * `log!(level, ...)` - the generic logging macro, takes a level as a u32 and any
  37                        related `format!` arguments
  38 * `debug!(...)` - a macro hard-wired to the log level of `DEBUG`
  39 * `info!(...)` - a macro hard-wired to the log level of `INFO`
  40 * `warn!(...)` - a macro hard-wired to the log level of `WARN`
  41 * `error!(...)` - a macro hard-wired to the log level of `ERROR`
  42
  43 All of these macros use the same style of syntax as the `format!` syntax
  44 extension. Details about the syntax can be found in the documentation of
  45 `std::fmt` along with the Rust tutorial/manual.
  46
  47 If you want to check at runtime if a given logging level is enabled (e.g. if the
  48 information you would want to log is expensive to produce), you can use the
  49 following macro:
  50
  51 * `log_enabled!(level)` - returns true if logging of the given level is enabled
  52
  53 ## Enabling logging
  54
  55 Log levels are controlled on a per-module basis, and by default all logging is
  56 disabled except for `error!` (a log level of 1). Logging is controlled via the
  57 `RUST_LOG` environment variable. The value of this environment variable is a
  58 comma-separated list of logging directives. A logging directive is of the form:
  59
  60 ```notrust
  61 path::to::module=log_level
  62 ```
  63
  64 The path to the module is rooted in the name of the crate it was compiled for,
  65 so if your program is contained in a file `hello.rs`, for example, to turn on
  66 logging for this file you would use a value of `RUST_LOG=hello`.
  67 Furthermore, this path is a prefix-search, so all modules nested in the
  68 specified module will also have logging enabled.
  69
  70 The actual `log_level` is optional to specify. If omitted, all logging will be
  71 enabled. If specified, the it must be either a numeric in the range of 1-255, or
  72 it must be one of the strings `debug`, `error`, `info`, or `warn`. If a numeric
  73 is specified, then all logging less than or equal to that numeral is enabled.
  74 For example, if logging level 3 is active, error, warn, and info logs will be
  75 printed, but debug will be omitted.
  76
  77 As the log level for a module is optional, the module to enable logging for is
  78 also optional. If only a `log_level` is provided, then the global log level for
  79 all modules is set to this value.
  80
  81 Some examples of valid values of `RUST_LOG` are:
  82
  83 ```notrust
  84 hello                // turns on all logging for the 'hello' module
  85 info                 // turns on all info logging
  86 hello=debug          // turns on debug logging for 'hello'
  87 hello=3              // turns on info logging for 'hello'
  88 hello,std::option    // turns on hello, and std's option logging
  89 error,hello=warn     // turn on global error logging and also warn for hello
  90 ```
  91
  92 ## Performance and Side Effects
  93
  94 Each of these macros will expand to code similar to:
  95
  96 ```rust,ignore
  97 if log_level <= my_module_log_level() {
  98     ::log::log(log_level, format!(...));
  99 }
 100 ```
 101
 102 What this means is that each of these macros are very cheap at runtime if
 103 they're turned off (just a load and an integer comparison). This also means that
 104 if logging is disabled, none of the components of the log will be executed.
 105
 106 */
 107
 108 #![crate_id = "log#0.11-pre"]
 109 #![license = "MIT/ASL2"]
 110 #![crate_type = "rlib"]
 111 #![crate_type = "dylib"]
 112 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
 113        html_favicon_url = "http://www.rust-lang.org/favicon.ico",
 114        html_root_url = "http://static.rust-lang.org/doc/master")]
 115
 116 #![feature(macro_rules)]
 117 #![deny(missing_doc, deprecated_owned_vector)]
 118
 119 extern crate sync;
 120
 121 use std::cast;
 122 use std::fmt;
 123 use std::io::LineBufferedWriter;
 124 use std::io;
 125 use std::local_data;
 126 use std::os;
 127 use std::rt;
 128 use std::slice;
 129
 130 use sync::one::{Once, ONCE_INIT};
 131
 132 use directive::LOG_LEVEL_NAMES;
 133
 134 pub mod macros;
 135 mod directive;
 136
 137 /// Maximum logging level of a module that can be specified. Common logging
 138 /// levels are found in the DEBUG/INFO/WARN/ERROR constants.
 139 pub static MAX_LOG_LEVEL: u32 = 255;
 140
 141 /// The default logging level of a crate if no other is specified.
 142 static DEFAULT_LOG_LEVEL: u32 = 1;
 143
 144 /// An unsafe constant that is the maximum logging level of any module
 145 /// specified. This is the first line of defense to determining whether a
 146 /// logging statement should be run.
 147 static mut LOG_LEVEL: u32 = MAX_LOG_LEVEL;
 148
 149 static mut DIRECTIVES: *Vec<directive::LogDirective> =
 150     0 as *Vec<directive::LogDirective>;
 151
 152 /// Debug log level
 153 pub static DEBUG: u32 = 4;
 154 /// Info log level
 155 pub static INFO: u32 = 3;
 156 /// Warn log level
 157 pub static WARN: u32 = 2;
 158 /// Error log level
 159 pub static ERROR: u32 = 1;
 160
 161 local_data_key!(local_logger: ~Logger:Send)
 162
 163 /// A trait used to represent an interface to a task-local logger. Each task
 164 /// can have its own custom logger which can respond to logging messages
 165 /// however it likes.
 166 pub trait Logger {
 167     /// Logs a single message described by the `record`.
 168     fn log(&mut self, record: &LogRecord);
 169 }
 170
 171 struct DefaultLogger {
 172     handle: LineBufferedWriter<io::stdio::StdWriter>,
 173 }
 174
 175 /// Wraps the log level with fmt implementations.
 176 #[deriving(Eq, Ord)]
 177 pub struct LogLevel(pub u32);
 178
 179 impl fmt::Show for LogLevel {
 180     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
 181         let LogLevel(level) = *self;
 182         match LOG_LEVEL_NAMES.get(level as uint - 1) {
 183             Some(name) => name.fmt(fmt),
 184             None => level.fmt(fmt)
 185         }
 186     }
 187 }
 188
 189 impl fmt::Signed for LogLevel {
 190     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
 191         let LogLevel(level) = *self;
 192         write!(fmt.buf, "{}", level)
 193     }
 194 }
 195
 196 impl Logger for DefaultLogger {
 197     fn log(&mut self, record: &LogRecord) {
 198         match write!(&mut self.handle,
 199                      "{}:{}: {}",
 200                      record.level,
 201                      record.module_path,
 202                      record.args) {
 203             Err(e) => fail!("failed to log: {}", e),
 204             Ok(()) => {}
 205         }
 206     }
 207 }
 208
 209 impl Drop for DefaultLogger {
 210     fn drop(&mut self) {
 211         // FIXME(#12628): is failure the right thing to do?
 212         match self.handle.flush() {
 213             Err(e) => fail!("failed to flush a logger: {}", e),
 214             Ok(()) => {}
 215         }
 216     }
 217 }
 218
 219 /// This function is called directly by the compiler when using the logging
 220 /// macros. This function does not take into account whether the log level
 221 /// specified is active or not, it will always log something if this method is
 222 /// called.
 223 ///
 224 /// It is not recommended to call this function directly, rather it should be
 225 /// invoked through the logging family of macros.
 226 #[doc(hidden)]
 227 pub fn log(level: u32, loc: &'static LogLocation, args: &fmt::Arguments) {
 228     // Completely remove the local logger from TLS in case anyone attempts to
 229     // frob the slot while we're doing the logging. This will destroy any logger
 230     // set during logging.
 231     let mut logger = local_data::pop(local_logger).unwrap_or_else(|| {
 232         box DefaultLogger { handle: io::stderr() } as ~Logger:Send
 233     });
 234     logger.log(&LogRecord {
 235         level: LogLevel(level),
 236         args: args,
 237         file: loc.file,
 238         module_path: loc.module_path,
 239         line: loc.line,
 240     });
 241     local_data::set(local_logger, logger);
 242 }
 243
 244 /// Getter for the global log level. This is a function so that it can be called
 245 /// safely
 246 #[doc(hidden)]
 247 #[inline(always)]
 248 pub fn log_level() -> u32 { unsafe { LOG_LEVEL } }
 249
 250 /// Replaces the task-local logger with the specified logger, returning the old
 251 /// logger.
 252 pub fn set_logger(logger: ~Logger:Send) -> Option<~Logger:Send> {
 253     let prev = local_data::pop(local_logger);
 254     local_data::set(local_logger, logger);
 255     return prev;
 256 }
 257
 258 /// A LogRecord is created by the logging macros, and passed as the only
 259 /// argument to Loggers.
 260 #[deriving(Show)]
 261 pub struct LogRecord<'a> {
 262
 263     /// The module path of where the LogRecord originated.
 264     pub module_path: &'a str,
 265
 266     /// The LogLevel of this record.
 267     pub level: LogLevel,
 268
 269     /// The arguments from the log line.
 270     pub args: &'a fmt::Arguments<'a>,
 271
 272     /// The file of where the LogRecord originated.
 273     pub file: &'a str,
 274
 275     /// The line number of where the LogRecord originated.
 276     pub line: uint,
 277 }
 278
 279 #[doc(hidden)]
 280 pub struct LogLocation {
 281     pub module_path: &'static str,
 282     pub file: &'static str,
 283     pub line: uint,
 284 }
 285
 286 /// Tests whether a given module's name is enabled for a particular level of
 287 /// logging. This is the second layer of defense about determining whether a
 288 /// module's log statement should be emitted or not.
 289 #[doc(hidden)]
 290 pub fn mod_enabled(level: u32, module: &str) -> bool {
 291     static mut INIT: Once = ONCE_INIT;
 292     unsafe { INIT.doit(init); }
 293
 294     // It's possible for many threads are in this function, only one of them
 295     // will peform the global initialization, but all of them will need to check
 296     // again to whether they should really be here or not. Hence, despite this
 297     // check being expanded manually in the logging macro, this function checks
 298     // the log level again.
 299     if level > unsafe { LOG_LEVEL } { return false }
 300
 301     // This assertion should never get tripped unless we're in an at_exit
 302     // handler after logging has been torn down and a logging attempt was made.
 303     assert!(unsafe { !DIRECTIVES.is_null() });
 304
 305     enabled(level, module, unsafe { (*DIRECTIVES).iter() })
 306 }
 307
 308 fn enabled(level: u32, module: &str,
 309            iter: slice::Items<directive::LogDirective>) -> bool {
 310     // Search for the longest match, the vector is assumed to be pre-sorted.
 311     for directive in iter.rev() {
 312         match directive.name {
 313             Some(ref name) if !module.starts_with(*name) => {},
 314             Some(..) | None => {
 315                 return level <= directive.level
 316             }
 317         }
 318     }
 319     level <= DEFAULT_LOG_LEVEL
 320 }
 321
 322 /// Initialize logging for the current process.
 323 ///
 324 /// This is not threadsafe at all, so initialization os performed through a
 325 /// `Once` primitive (and this function is called from that primitive).
 326 fn init() {
 327     let mut directives = match os::getenv("RUST_LOG") {
 328         Some(spec) => directive::parse_logging_spec(spec),
 329         None => Vec::new(),
 330     };
 331
 332     // Sort the provided directives by length of their name, this allows a
 333     // little more efficient lookup at runtime.
 334     directives.sort_by(|a, b| {
 335         let alen = a.name.as_ref().map(|a| a.len()).unwrap_or(0);
 336         let blen = b.name.as_ref().map(|b| b.len()).unwrap_or(0);
 337         alen.cmp(&blen)
 338     });
 339
 340     let max_level = {
 341         let max = directives.iter().max_by(|d| d.level);
 342         max.map(|d| d.level).unwrap_or(DEFAULT_LOG_LEVEL)
 343     };
 344
 345     unsafe {
 346         LOG_LEVEL = max_level;
 347
 348         assert!(DIRECTIVES.is_null());
 349         DIRECTIVES = cast::transmute(box directives);
 350
 351         // Schedule the cleanup for this global for when the runtime exits.
 352         rt::at_exit(proc() {
 353             assert!(!DIRECTIVES.is_null());
 354             let _directives: ~Vec<directive::LogDirective> =
 355                 cast::transmute(DIRECTIVES);
 356             DIRECTIVES = 0 as *Vec<directive::LogDirective>;
 357         });
 358     }
 359 }
 360
 361 #[cfg(test)]
 362 mod tests {
 363     use super::enabled;
 364     use directive::LogDirective;
 365
 366     #[test]
 367     fn match_full_path() {
 368         let dirs = [LogDirective { name: Some("crate2".to_owned()), level: 3 },
 369                     LogDirective { name: Some("crate1::mod1".to_owned()), level: 2 }];
 370         assert!(enabled(2, "crate1::mod1", dirs.iter()));
 371         assert!(!enabled(3, "crate1::mod1", dirs.iter()));
 372         assert!(enabled(3, "crate2", dirs.iter()));
 373         assert!(!enabled(4, "crate2", dirs.iter()));
 374     }
 375
 376     #[test]
 377     fn no_match() {
 378         let dirs = [LogDirective { name: Some("crate2".to_owned()), level: 3 },
 379                     LogDirective { name: Some("crate1::mod1".to_owned()), level: 2 }];
 380         assert!(!enabled(2, "crate3", dirs.iter()));
 381     }
 382
 383     #[test]
 384     fn match_beginning() {
 385         let dirs = [LogDirective { name: Some("crate2".to_owned()), level: 3 },
 386                     LogDirective { name: Some("crate1::mod1".to_owned()), level: 2 }];
 387         assert!(enabled(3, "crate2::mod1", dirs.iter()));
 388     }
 389
 390     #[test]
 391     fn match_beginning_longest_match() {
 392         let dirs = [LogDirective { name: Some("crate2".to_owned()), level: 3 },
 393                     LogDirective { name: Some("crate2::mod".to_owned()), level: 4 },
 394                     LogDirective { name: Some("crate1::mod1".to_owned()), level: 2 }];
 395         assert!(enabled(4, "crate2::mod1", dirs.iter()));
 396         assert!(!enabled(4, "crate2", dirs.iter()));
 397     }
 398
 399     #[test]
 400     fn match_default() {
 401         let dirs = [LogDirective { name: None, level: 3 },
 402                     LogDirective { name: Some("crate1::mod1".to_owned()), level: 2 }];
 403         assert!(enabled(2, "crate1::mod1", dirs.iter()));
 404         assert!(enabled(3, "crate2::mod2", dirs.iter()));
 405     }
 406
 407     #[test]
 408     fn zero_level() {
 409         let dirs = [LogDirective { name: None, level: 3 },
 410                     LogDirective { name: Some("crate1::mod1".to_owned()), level: 0 }];
 411         assert!(!enabled(1, "crate1::mod1", dirs.iter()));
 412         assert!(enabled(3, "crate2::mod2", dirs.iter()));
 413     }
 414 }