|
| 1 | +use crate::rprintln; |
| 2 | +use once_cell::sync::OnceCell; |
| 3 | + |
| 4 | +struct Logger { |
| 5 | + level_filter: log::LevelFilter, |
| 6 | +} |
| 7 | + |
| 8 | +impl log::Log for Logger { |
| 9 | + /// Returns if logger is enabled. |
| 10 | + fn enabled(&self, metadata: &log::Metadata) -> bool { |
| 11 | + metadata.level() <= self.level_filter |
| 12 | + } |
| 13 | + |
| 14 | + /// Log the record. |
| 15 | + fn log(&self, record: &log::Record) { |
| 16 | + if self.enabled(record.metadata()) { |
| 17 | + rprintln!( |
| 18 | + "{:<5} [{}] {}", |
| 19 | + record.level(), |
| 20 | + record.target(), |
| 21 | + record.args() |
| 22 | + ); |
| 23 | + } |
| 24 | + } |
| 25 | + |
| 26 | + /// Flush buffered records. |
| 27 | + fn flush(&self) { |
| 28 | + // Nothing to do here |
| 29 | + } |
| 30 | +} |
| 31 | + |
| 32 | +static LOGGER: OnceCell<Logger> = OnceCell::new(); |
| 33 | + |
| 34 | +/// Init the logger with maximum level (Trace). |
| 35 | +/// |
| 36 | +/// Note: Normally there is no need to call this manually, use `rtt_init_log!` instead. |
| 37 | +pub fn init_logger() { |
| 38 | + init_logger_with_level(log::LevelFilter::Trace); |
| 39 | +} |
| 40 | + |
| 41 | +/// Init the logger with a specific level. |
| 42 | +/// |
| 43 | +/// Note: Normally there is no need to call this manually, use `rtt_init_log!` instead. |
| 44 | +pub fn init_logger_with_level(level_filter: log::LevelFilter) { |
| 45 | + // Logger was already initialized. |
| 46 | + if LOGGER.get().is_some() { |
| 47 | + return; |
| 48 | + } |
| 49 | + let logger = LOGGER.get_or_init(|| Logger { level_filter }); |
| 50 | + |
| 51 | + // Use racy init if the feature is enabled or the target doesn't support atomic pointers. |
| 52 | + #[cfg(any(not(target_has_atomic = "ptr"), feature = "log_racy_init"))] |
| 53 | + unsafe { |
| 54 | + init_racy(logger); |
| 55 | + } |
| 56 | + |
| 57 | + // Use the default init otherwise. |
| 58 | + #[cfg(all(target_has_atomic = "ptr", not(feature = "log_racy_init")))] |
| 59 | + init_default(logger); |
| 60 | +} |
| 61 | + |
| 62 | +#[cfg(all(target_has_atomic = "ptr", not(feature = "log_racy_init")))] |
| 63 | +fn init_default(logger: &'static Logger) { |
| 64 | + log::set_logger(logger).ok(); |
| 65 | + log::set_max_level(logger.level_filter); |
| 66 | +} |
| 67 | + |
| 68 | +// # Safety |
| 69 | +// |
| 70 | +// This function will call the unsafe functions [log::set_logger_racy] and |
| 71 | +// [log::set_max_level_racy] if either the feature `log_racy_init` is enabled or the target doesn't |
| 72 | +// support atomic pointers. The [once_cell::OnceCell] should ensure that this is only called |
| 73 | +// once. |
| 74 | +#[cfg(any(not(target_has_atomic = "ptr"), feature = "log_racy_init"))] |
| 75 | +unsafe fn init_racy(logger: &'static Logger) { |
| 76 | + log::set_logger_racy(logger).ok(); |
| 77 | + log::set_max_level_racy(logger.level_filter); |
| 78 | +} |
| 79 | + |
| 80 | +/// Initializes RTT with a single up channel, sets it as the print channel for the printing macros |
| 81 | +/// and sets up a log backend with the given log level. |
| 82 | +/// |
| 83 | +/// The optional arguments specify the level filter (default: `log::LevelFilter::Trace`), |
| 84 | +/// the blocking mode (default: `NoBlockSkip`) and size of the buffer in bytes (default: 1024). |
| 85 | +/// |
| 86 | +/// See [`rtt_init`] for more details. |
| 87 | +/// |
| 88 | +/// [`rtt_init`]: crate::rtt_init |
| 89 | +#[macro_export] |
| 90 | +macro_rules! rtt_init_log { |
| 91 | + ($level:path, $mode:path, $size:expr) => {{ |
| 92 | + $crate::rtt_init_print!($mode, $size); |
| 93 | + $crate::init_logger_with_level($level); |
| 94 | + }}; |
| 95 | + |
| 96 | + ($level:path, $mode:path) => { |
| 97 | + $crate::rtt_init_log!($level, $mode, 1024); |
| 98 | + }; |
| 99 | + |
| 100 | + ($level:path) => {{ |
| 101 | + use $crate::ChannelMode::NoBlockSkip; |
| 102 | + $crate::rtt_init_log!($level, NoBlockSkip, 1024); |
| 103 | + }}; |
| 104 | + |
| 105 | + () => {{ |
| 106 | + use log::LevelFilter::Trace; |
| 107 | + use $crate::ChannelMode::NoBlockSkip; |
| 108 | + $crate::rtt_init_log!(Trace, NoBlockSkip, 1024); |
| 109 | + }}; |
| 110 | +} |
0 commit comments