1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
//! Ultra lightweight logging framework for resource constrained devices
//!
//! ![stlog running on a Cortex-M microcontroller](https://i.imgur.com/rPxmAlZ.jpg)
//!
//! **[See stlog in action!](https://streamable.com/nmlx7)**
//!
//! # Features
//!
//! - `O(1)` execution time. Logging a message of arbitrary size is done in a constant number of
//! instructions.
//!
//! - `O(0)` memory usage. The messages are NOT stored in the target device memory.
//!
//! - Supports different logging levels: error, warning, info, debug and trace, in decreasing level
//! of severity. By default, the `dev` profile logs debug, and more severe, messages and the
//! `release` profile logs info, and more severe, messages, but this can changed using the Cargo
//! features of this crate.
//!
//! - Provides a global logging mode
//!
//! # Non-features
//!
//! - `printf` style or any other kind of formatting
//!
//! # Known limitations
//!
//! - The current implementation only supports 256 different log strings. This restriction may be
//! lifted in the future.
//!
//! - The exact same string can't be used in two or more macro invocations. This restriction will be
//! lifted when procedural macros that expand into expressions are allowed on stable.
//!
//! ``` ignore
//! use stlog::{error, info};
//!
//! fn foo() {
//!     info!("Hello!");
//! }
//!
//! fn good() {
//!     foo();
//!     foo();
//! }
//!
//! fn bad() {
//!     info!("Hey!");
//!     info!("Hey!"); //~ ERROR symbol `Hey!` is already defined
//! }
//!
//! fn also_bad() {
//!     info!("Bye!");
//!     error!("Bye!"); //~ ERROR symbol `Bye!` is already defined
//! }
//! ```
//!
//! # Requirements
//!
//! The target application must be linked using the `stlog.x` linker script provided by this crate.
//! The easiest way to do this is to append the `-C link-arg` to the other rustc flags using a Cargo
//! configuration file (`.cargo/config`).
//!
//! ``` toml
//! [target.thumbv7m-none-eabi]
//! rustflags = [
//!     "-C", "link-arg=-Tstlog.x",
//!     # ..
//! ]
//! ```
//!
//! To decode the logs on the host you'll need version v0.2.x of the [`stcat`] tool.
//!
//! [`stcat`]: https://crates.io/crates/stcat
//!
//! # Example
//!
//! ## Local logger
//!
//! - Device side
//!
//! ```
//! extern crate stlog;
//!
//! use stlog::{info, warn, Log};
//!
//! struct Logger {
//!     // ..
//! #   _0: (),
//! }
//!
//! impl Log for Logger {
//!     // ..
//! #   type Error = ();
//! #
//! #   fn log(&mut self, _: u8) -> Result<(), ()> {
//! #       Ok(())
//! #   }
//! }
//!
//! fn main() {
//!     let mut logger = Logger {
//!         // ..
//! #       _0: (),
//!     };
//!
//!     info!(logger, "Hello, world!");
//!     warn!(logger, "The quick brown fox jumps over the lazy dog");
//! }
//! ```
//!
//! - Host side
//!
//! Assuming that the device is `log`ging through the `/dev/ttyUSB0` interface.
//!
//! ``` text
//! $ flash-and-run /path/to/device/binary
//!
//! $ cat /dev/ttyUSB0 | stcat -e /path/to/device/binary
//! Sept 22 13:00:00.000 INFO Hello, world!
//! Sept 22 13:00:00.001 WARN The quick brown fox jumps over the lazy dog
//! ```
//!
//! ## Global logger
//!
//! If the first argument is omitted from the logging macros then logging will be done through the
//! global logger. The global logger must be selected using the `global_logger` attribute *in the
//! top crate*.
//!
//! ``` ignore
//! use stlog::{info, GlobalLog};
//!
//! struct Logger;
//!
//! impl GlobalLog for Logger { .. }
//!
//! #[global_logger]
//! static LOGGER: Logger = Logger;
//!
//! fn main() {
//!     info!("Hello");
//! }
//!
//! #[interrupt]
//! fn SomeInterrupt() {
//!     info!("World");
//! }
//! ```
//!
//! # Troubleshooting
//!
//! ## Didn't pass `-Tstlog.x` to the linker
//!
//! Symptom: you'll get an error when linking the target application or when calling `stcat`.
//!
//! ``` text
//! $ cargo build
//! error: linking with `rust-lld` failed: exit code: 1
//!   |
//!   = note: "rust-lld" (..)
//!   = note: rust-lld: error: no memory region specified for section '.stlog.info'
//!           rust-lld: error: no memory region specified for section '.stlog.error'
//!
//! $ stcat -e /path/to/binary logfile
//! error: symbol `__stlog_error_start__` not found
//! ```
//!
//! Pass `-Tstlog.x` to the linker as explained in the requirements section.
//!
//! ## Didn't set a `global_logger`
//!
//! Symptom: you'll get an error when linking the program
//!
//! ``` text
//! $ cargo build
//! error: linking with `rust-lld` failed: exit code: 1
//!   |
//!   = note: "rust-lld" (..)
//!   = note: rust-lld: error: undefined symbol: stlog::GLOBAL_LOGGER
//! ```

#![no_std]
#![deny(warnings)]

extern crate stlog_macros;

pub use stlog_macros::global_logger;

/// A global version of the [`Log`](trait.Log) trait
///
/// This is very similar to [`Log`](trait.Log) except that the implementor must ensure that this
/// method is synchronized with other invocations of itself that could occur concurrently. Also,
/// note that there the return type is `()` and not `Result` so errors must be handled by the `log`
/// method.
pub trait GlobalLog: Sync {
    fn log(&self, address: u8);
}

/// A logger that encodes messages using a symbol table
///
/// # Contract
///
/// The implementation of the `log` method MUST send its argument as a single byte through some
/// interface.
pub trait Log {
    /// Error type of the log operation
    type Error;

    /// Sends the `address` of the symbol through some interface
    fn log(&mut self, address: u8) -> Result<(), Self::Error>;
}

/// Logs the given string literal at the ERROR log level
///
/// `$logger` must be an expression whose type implements the [`Log`](trait.Log.html) trait.
///
/// If `$logger` is omitted the global logger will be used.
#[macro_export]
macro_rules! error {
    ($logger:expr, $string:expr) => {{
        if $crate::max_level() as u8 >= $crate::Level::Error as u8 {
            #[export_name = $string]
            #[link_section = ".stlog.error"]
            static SYMBOL: u8 = 0;

            $crate::Log::log(&mut $logger, &SYMBOL as *const u8 as usize as u8)
        } else {
            Ok(())
        }
    }};

    ($string:expr) => {
        unsafe {
            if $crate::max_level() as u8 >= $crate::Level::Error as u8 {
                extern "Rust" {
                    #[link_name = "stlog::GLOBAL_LOGGER"]
                    static LOGGER: &'static $crate::GlobalLog;
                }

                #[export_name = $string]
                #[link_section = ".stlog.error"]
                static SYMBOL: u8 = 0;

                $crate::GlobalLog::log(LOGGER, &SYMBOL as *const u8 as usize as u8)
            }
        }
    };
}

/// Logs the given string literal at the WARNING log level
///
/// For more details see the [`error!`](macro.error.html) macro.
#[macro_export]
macro_rules! warn {
    ($logger:expr, $string:expr) => {{
        if $crate::max_level() as u8 >= $crate::Level::Warn as u8 {
            #[export_name = $string]
            #[link_section = ".stlog.warn"]
            static SYMBOL: u8 = 0;

            $crate::Log::log(&mut $logger, &SYMBOL as *const u8 as usize as u8)
        } else {
            Ok(())
        }
    }};

    ($string:expr) => {
        unsafe {
            if $crate::max_level() as u8 >= $crate::Level::Warn as u8 {
                extern "Rust" {
                    #[link_name = "stlog::GLOBAL_LOGGER"]
                    static LOGGER: &'static $crate::GlobalLog;
                }

                #[export_name = $string]
                #[link_section = ".stlog.warn"]
                static SYMBOL: u8 = 0;

                $crate::GlobalLog::log(LOGGER &SYMBOL as *const u8 as usize as u8)
            }
        }
    };
}

/// Logs the given string literal at the INFO log level
///
/// For more details see the [`error!`](macro.error.html) macro.
#[macro_export]
macro_rules! info {
    ($logger:expr, $string:expr) => {{
        if $crate::max_level() as u8 >= $crate::Level::Info as u8 {
            #[export_name = $string]
            #[link_section = ".stlog.info"]
            static SYMBOL: u8 = 0;

            $crate::Log::log(&mut $logger, &SYMBOL as *const u8 as usize as u8)
        } else {
            Ok(())
        }
    }};

    ($string:expr) => {
        unsafe {
            if $crate::max_level() as u8 >= $crate::Level::Info as u8 {
                extern "Rust" {
                    #[link_name = "stlog::GLOBAL_LOGGER"]
                    static LOGGER: &'static $crate::GlobalLog;
                }

                #[export_name = $string]
                #[link_section = ".stlog.info"]
                static SYMBOL: u8 = 0;

                $crate::GlobalLog::log(LOGGER, &SYMBOL as *const u8 as usize as u8)
            }
        }
    };
}

/// Logs the given string literal at the DEBUG log level
///
/// For more details see the [`error!`](macro.error.html) macro.
#[macro_export]
macro_rules! debug {
    ($log:expr, $string:expr) => {{
        if $crate::max_level() as u8 >= $crate::Level::Debug as u8 {
            #[export_name = $string]
            #[link_section = ".stlog.debug"]
            static SYMBOL: u8 = 0;

            $crate::Log::log(&mut $log, &SYMBOL as *const u8 as usize as u8)
        } else {
            Ok(())
        }
    }};

    ($string:expr) => {
        unsafe {
            if $crate::max_level() as u8 >= $crate::Level::Debug as u8 {
                extern "Rust" {
                    #[link_name = "stlog::GLOBAL_LOGGER"]
                    static LOGGER: &'static $crate::GlobalLog;
                }

                #[export_name = $string]
                #[link_section = ".stlog.debug"]
                static SYMBOL: u8 = 0;

                $crate::GlobalLog::log(LOGGER, &SYMBOL as *const u8 as usize as u8)
            }
        }
    };
}

/// Logs the given string literal at the TRACE log level
///
/// For more details see the [`error!`](macro.error.html) macro.
#[macro_export]
macro_rules! trace {
    ($logger:expr, $string:expr) => {{
        if $crate::max_level() as u8 >= $crate::Level::Trace as u8 {
            #[export_name = $string]
            #[link_section = ".stlog.trace"]
            static SYMBOL: u8 = 0;

            $crate::Log::log(&mut $logger, &SYMBOL as *const u8 as usize as u8)
        } else {
            Ok(())
        }
    }};

    ($string:expr) => {
        unsafe {
            if $crate::max_level() as u8 >= $crate::Level::Trace as u8 {
                extern "Rust" {
                    #[link_name = "stlog::GLOBAL_LOGGER"]
                    static LOGGER: &'static $crate::GlobalLog;
                }

                #[export_name = $string]
                #[link_section = ".stlog.trace"]
                static SYMBOL: u8 = 0;

                $crate::GlobalLog::log(LOGGER, &SYMBOL as *const u8 as usize as u8)
            }
        }
    };
}

#[doc(hidden)]
pub enum Level {
    Off = 0,
    Error = 1,
    Warn = 2,
    Info = 3,
    Debug = 4,
    Trace = 5,
}

#[doc(hidden)]
#[inline(always)]
pub fn max_level() -> Level {
    match () {
        #[cfg(debug_assertions)]
        () => {
            #[cfg(feature = "max-level-off")]
            return Level::Off;

            #[cfg(feature = "max-level-error")]
            return Level::Error;

            #[cfg(feature = "max-level-warn")]
            return Level::Warn;

            #[cfg(feature = "max-level-info")]
            return Level::Info;

            #[cfg(feature = "max-level-debug")]
            return Level::Debug;

            #[cfg(feature = "max-level-trace")]
            return Level::Trace;

            #[allow(unreachable_code)]
            Level::Debug
        }
        #[cfg(not(debug_assertions))]
        () => {
            #[cfg(feature = "release-max-level-off")]
            return Level::Off;

            #[cfg(feature = "release-max-level-error")]
            return Level::Error;

            #[cfg(feature = "release-max-level-warn")]
            return Level::Warn;

            #[cfg(feature = "release-max-level-info")]
            return Level::Info;

            #[cfg(feature = "release-max-level-debug")]
            return Level::Debug;

            #[cfg(feature = "release-max-level-trace")]
            return Level::Trace;

            #[allow(unreachable_code)]
            Level::Info
        }
    }
}