refactor(core/rust): add ufmt-based logging macros
What changed, and why it matters
This commit is a routine internal refactoring of how debug logging is implemented in the Trezor firmware's Rust code. It introduces a new lightweight logging system based on the ufmt library and adds build options to control the maximum log level. There is no indication this change fixes a security vulnerability or introduces a new security risk.
No security action required. Treat as normal development refactoring.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit refactors logging macros in the embedded Rust portion of Trezor firmware. It adds a new ulog module with ufmt-based macros, exposes compile-time log-level features through Cargo and project.toml, and updates the xtask build tooling to support a log-level option. The syslog module now reuses the LogLevel enum from ulog. No cryptographic, memory-safety, or access-control changes are present.
Changed components
core/embed/sys/src/ulog.rscore/embed/sys/src/syslog.rscore/embed/sys/Cargo.tomlcore/embed/sys/build.rscore/embed/sys/dbg/build.rscore/embed/rust/Cargo.tomlcore/embed/projects/*/project.tomlcore/embed/xtaskInspect captured patch +208 / −13
### core/embed/projects/boardloader/project.toml
@@ -28,3 +28,4 @@ production = { true = ["production"] }
bootloader-devel = { true = ["bootloader_devel"] }
dbg-console = { swo = ["dbg_console_swo"], system-view = ["dbg_console_system_view"] }
log-external = { true = ["sys/log_external"] }
+log-level = { off = ["sys/log_max_off"], error = ["sys/log_max_error"], warn = ["sys/log_max_warn"], info = ["sys/log_max_info"], debug = ["sys/log_max_debug"] }
### core/embed/projects/bootloader/project.toml
@@ -53,5 +53,6 @@ dbg-console = { vcp = ["dbg_console_vcp"], swo = ["dbg_console_swo"], syst
debug-link = { true = ["debuglink", "ui_debug"] }
disable-animation = { true = ["disable_animation"] }
log-external = { true = ["sys/log_external"] }
+log-level = { off = ["sys/log_max_off"], error = ["sys/log_max_error"], warn = ["sys/log_max_warn"], info = ["sys/log_max_info"], debug = ["sys/log_max_debug"] }
perf-overlay = { true = ["ui_performance_overlay"] }
production = { true = ["production"] }
### core/embed/projects/bootloader_ci/project.toml
@@ -35,4 +35,5 @@ asan = { true = ["asan"] }
bootloader-devel = { true = ["bootloader_devel"] }
dbg-console = { vcp = ["dbg_console_vcp"], swo = ["dbg_console_swo"], system-view = ["dbg_console_system_view"] }
log-external = { true = ["sys/log_external"] }
+log-level = { off = ["sys/log_max_off"], error = ["sys/log_max_error"], warn = ["sys/log_max_warn"], info = ["sys/log_max_info"], debug = ["sys/log_max_debug"] }
production = { true = ["production"] }
### core/embed/projects/firmware/project.toml
@@ -68,6 +68,7 @@ disable-animation = { true = ["disable_animation"] }
force-bootloader-upgrade = { true = ["force_bootloader_upgrade"] }
frozen = { true = ["frozen"] }
log-external = { true = ["sys/log_external"] }
+log-level = { off = ["sys/log_max_off"], error = ["sys/log_max_error"], warn = ["sys/log_max_warn"], info = ["sys/log_max_info"], debug = ["sys/log_max_debug"] }
log-stack-usage = { true = ["log_stack_usage"] }
mem-perf = { true = ["memperf"] }
miniscript = { true = ["miniscript"] }
### core/embed/projects/kernel/project.toml
@@ -53,6 +53,7 @@ dbg-console = { vcp = ["dbg_console_vcp"], swo = ["dbg_console
debug-link = { true = ["debuglink"] }
force-bootloader-upgrade = { true = ["force_bootloader_upgrade"] }
log-external = { true = ["sys/log_external"] }
+log-level = { off = ["sys/log_max_off"], error = ["sys/log_max_error"], warn = ["sys/log_max_warn"], info = ["sys/log_max_info"], debug = ["sys/log_max_debug"] }
n1w1 = { true = ["nfc"] } # TODO: move back to `uses` section (after stabilization)
production = { true = ["production"] }
pyopt = { false = ["optiga_testing"] }
### core/embed/projects/prodtest/project.toml
@@ -60,5 +60,6 @@ bootloader-devel = { true = ["bootloader_devel"] }
dbg-console = { swo = ["dbg_console_swo"], system-view = ["dbg_console_system_view"] }
debug-link = { true = ["debuglink", "ui_debug"] }
log-external = { true = ["sys/log_external"] }
+log-level = { off = ["sys/log_max_off"], error = ["sys/log_max_error"], warn = ["sys/log_max_warn"], info = ["sys/log_max_info"], debug = ["sys/log_max_debug"] }
perf-overlay = { true = ["ui_performance_overlay"] }
production = { true = ["production"] }
### core/embed/projects/secmon/project.toml
@@ -30,6 +30,7 @@ bootloader-devel = { true = ["bootloader_devel"] }
dbg-console = { swo = ["dbg_console_swo"], system-view = ["dbg_console_system_view"] }
force-bootloader-upgrade = { true = ["force_bootloader_upgrade"] }
log-external = { true = ["sys/log_external"] }
+log-level = { off = ["sys/log_max_off"], error = ["sys/log_max_error"], warn = ["sys/log_max_warn"], info = ["sys/log_max_info"], debug = ["sys/log_max_debug"] }
production = { true = ["production"] }
pyopt = { false = ["optiga_testing"] }
storage-insecure-testing-mode = { true = ["storage_insecure_testing_mode"] }
### core/embed/rust/Cargo.toml
@@ -133,6 +133,8 @@ test = [
"models/model_t2t1",
"sec/secret",
"sys/dbg_console",
+ "sys/log_external",
+ "sys/log_max_debug",
"upymod/emulator",
"upymod/layout_bolt",
"upymod/universal_fw",
### core/embed/sys/Cargo.toml
@@ -55,6 +55,11 @@ i2c_bus = []
ipc = []
lockable_bootloader = []
log_external = ["log"]
+log_max_off = ["log?/max_level_off", "log?/release_max_level_off"]
+log_max_error = ["log?/max_level_error", "log?/release_max_level_error"]
+log_max_warn = ["log?/max_level_warn", "log?/release_max_level_warn"]
+log_max_info = ["log?/max_level_info", "log?/release_max_level_info"]
+log_max_debug = ["log?/max_level_trace", "log?/release_max_level_trace"]
production = ["rtl/production"]
pvd = []
rtc = []
### core/embed/sys/build.rs
@@ -60,6 +60,8 @@ fn main() -> Result<()> {
lib.add_define("LOCKABLE_BOOTLOADER", None);
}
+ lib.add_rust_bindings(add_rust_bindings)?;
+
build_mods!(
lib,
[
@@ -86,3 +88,10 @@ fn main() -> Result<()> {
Ok(())
})
}
+
+fn add_rust_bindings(builder: bindgen::Builder) -> Result<bindgen::Builder> {
+ let builder = builder
+ .header("inc/sys/logging.h")
+ .allowlist_type("log_level_t");
+ Ok(builder)
+}
### core/embed/sys/dbg/build.rs
@@ -58,11 +58,9 @@ fn def_system_view(lib: &mut CLibrary) {
fn add_rust_bindings(builder: bindgen::Builder) -> Result<bindgen::Builder> {
let builder = builder
- .header("inc/sys/logging.h")
+ .allowlist_type("log_source_t")
.header("dbg/inc/sys/syslog.h")
.allowlist_function("syslog_start_record")
- .allowlist_function("syslog_write_chunk")
- .allowlist_type("log_source_t")
- .allowlist_type("log_level_t");
+ .allowlist_function("syslog_write_chunk");
Ok(builder)
}
### core/embed/sys/src/lib.rs
@@ -20,4 +20,6 @@ pub mod task;
#[cfg(all(feature = "dbg_console", feature = "log_external"))]
pub mod log_external;
+pub mod ulog;
+
pub mod time;
### core/embed/sys/src/syslog.rs
@@ -1,14 +1,7 @@
use rtl::CSlice;
use super::ffi;
-
-#[derive(PartialEq, Debug, Eq, Clone, Copy)]
-pub enum LogLevel {
- Debug = ffi::log_level_t_LOG_LEVEL_DBG as _,
- Info = ffi::log_level_t_LOG_LEVEL_INF as _,
- Warn = ffi::log_level_t_LOG_LEVEL_WARN as _,
- Error = ffi::log_level_t_LOG_LEVEL_ERR as _,
-}
+pub use crate::ulog::LogLevel;
impl From<&str> for ffi::log_source_t {
fn from(s: &str) -> Self {
### core/embed/sys/src/ulog.rs
@@ -0,0 +1,105 @@
+//! ufmt-based logging macros.
+//!
+//! Similar to the `log` crate but with only basic features and using ufmt
+//! instead of core::fmt. When logging is disabled, the invocation is dead code
+//! and gets optimized out.
+
+use super::ffi;
+
+#[derive(Debug, PartialEq, Eq, PartialOrd, Clone, Copy)]
+pub enum LogLevel {
+ /// Not a real level, used for filtering
+ Off = ffi::log_level_t_LOG_LEVEL_OFF as _,
+ Error = ffi::log_level_t_LOG_LEVEL_ERR as _,
+ Warn = ffi::log_level_t_LOG_LEVEL_WARN as _,
+ Info = ffi::log_level_t_LOG_LEVEL_INF as _,
+ Debug = ffi::log_level_t_LOG_LEVEL_DBG as _,
+}
+
+#[doc(hidden)]
+pub mod __private {
+ // `uwrite!` expands to relative `ufmt::` paths. Importing it in the macro
+ // body saves callers from having to depend on `ufmt` directly.
+ pub use ufmt;
+
+ #[cfg(feature = "dbg_console")]
+ pub use crate::syslog::log;
+
+ /// Dummy `syslog::log` to use without `dbg_console`.
+ #[cfg(not(feature = "dbg_console"))]
+ pub fn log<T, E, F>(_module: &str, _level: super::LogLevel, _log_fn: F) -> Result<Option<T>, E>
+ where
+ F: FnOnce(&mut dyn ufmt::uWrite<Error = ()>) -> Result<T, E>,
+ {
+ unreachable!()
+ }
+}
+
+// Static maximum log level used to optimize out calls with higher level at
+// compile-time.
+pub const STATIC_MAX_LEVEL: LogLevel = if !cfg!(feature = "dbg_console") {
+ LogLevel::Off
+} else if cfg!(feature = "log_max_debug") {
+ LogLevel::Debug
+} else if cfg!(feature = "log_max_info") {
+ LogLevel::Info
+} else if cfg!(feature = "log_max_warn") {
+ LogLevel::Warn
+} else if cfg!(feature = "log_max_error") {
+ LogLevel::Error
+} else {
+ LogLevel::Off
+};
+
+// `#[macro_export]` places macros at the crate root, so they are exported under
+// hidden unique names and only get their public names in this module.
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __ulog_log {
+ ($level:expr, $($args:tt)+) => ({
+ if $level <= $crate::ulog::STATIC_MAX_LEVEL {
+ use $crate::ulog::__private::ufmt;
+ $crate::ulog::__private::log(core::module_path!(), $level, |writer| {
+ ufmt::uwrite!(writer, $($args)+)
+ }).ok();
+ }
+ })
+}
+
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __ulog_debug {
+ ($($args:tt)+) => ({
+ $crate::ulog::log!($crate::ulog::LogLevel::Debug, $($args)+)
+ })
+}
+
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __ulog_info {
+ ($($args:tt)+) => ({
+ $crate::ulog::log!($crate::ulog::LogLevel::Info, $($args)+)
+ })
+}
+
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __ulog_warn {
+ ($($args:tt)+) => ({
+ $crate::ulog::log!($crate::ulog::LogLevel::Warn, $($args)+)
+ })
+}
+
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __ulog_error {
+ ($($args:tt)+) => ({
+ $crate::ulog::log!($crate::ulog::LogLevel::Error, $($args)+)
+ })
+}
+
+pub use __ulog_debug as debug;
+pub use __ulog_error as error;
+pub use __ulog_info as info;
+pub use __ulog_log as log;
+pub use __ulog_warn as warn;
### core/embed/xtask/presets.toml
@@ -16,6 +16,7 @@ when = { emulator = true }
dbg-console = "swo" # required by prodtest test
debug = true
source-lines = true # required by test coverage
+log-level = "debug"
log-external = true
[[defaults]]
@@ -55,6 +56,7 @@ source-lines = true
when = { emulator = false, project = ["firmware", "prodtest"] }
dbg-console = "swo"
pyopt = false
+log-level = "warn"
# Example of a model- and project-specific fragment:
#
### core/embed/xtask/src/args.rs
@@ -112,6 +112,17 @@ pub enum ConsoleType {
SystemView,
}
+#[derive(ValueEnum, Debug, Clone, Copy, Default, Deserialize, PartialEq, Eq)]
+#[serde(rename_all = "lowercase")]
+pub enum LogLevel {
+ #[default]
+ Off,
+ Error,
+ Warn,
+ Info,
+ Debug,
+}
+
#[derive(Parser, Debug)]
#[command(name = "xtask")]
#[command(about = "Trezor workspace automation tasks")]
### core/embed/xtask/src/options.rs
@@ -2,7 +2,7 @@ use anyhow::Result;
use clap::Args;
use serde::Deserialize;
-use crate::args::{BuildArgs, ConsoleType, Model, Project};
+use crate::args::{BuildArgs, ConsoleType, LogLevel, Model, Project};
use crate::presets;
/// How an option's `Option<T>` value from the defaults/presets/CLI layers is
@@ -28,6 +28,13 @@ impl ResolveValue for ConsoleType {
}
}
+impl ResolveValue for LogLevel {
+ type Resolved = LogLevel;
+ fn resolve(value: Option<Self>) -> Self::Resolved {
+ value.unwrap_or_default()
+ }
+}
+
/// The board selection stays optional; unset means the model's default board.
impl ResolveValue for String {
type Resolved = Option<String>;
@@ -190,6 +197,10 @@ build_options! {
#[arg(long, num_args = 0..=1, default_missing_value = "false")]
map log_external: bool,
+ /// Compile-time log level filter
+ #[arg(long)]
+ map log_level: LogLevel,
+
/// Optimize MicroPython bytecode
#[arg(long, num_args = 0..=1, default_missing_value = "true", overrides_with = "pyopt")]
map pyopt: bool,
@@ -340,6 +351,34 @@ pub struct ConsoleMap {
pub system_view: Vec<String>,
}
+impl MapValue for LogLevel {
+ type Map = LogLevelMap;
+ fn select(map: &Self::Map, value: Self) -> &[String] {
+ match value {
+ LogLevel::Off => &map.off,
+ LogLevel::Error => &map.error,
+ LogLevel::Warn => &map.warn,
+ LogLevel::Info => &map.info,
+ LogLevel::Debug => &map.debug,
+ }
+ }
+}
+
+#[derive(Deserialize, Debug, Clone, Default)]
+#[serde(deny_unknown_fields, rename_all = "kebab-case")]
+pub struct LogLevelMap {
+ #[serde(default)]
+ pub off: Vec<String>,
+ #[serde(default)]
+ pub error: Vec<String>,
+ #[serde(default)]
+ pub warn: Vec<String>,
+ #[serde(default)]
+ pub info: Vec<String>,
+ #[serde(default)]
+ pub debug: Vec<String>,
+}
+
/// A feature selected from the `[build-options]` table, together with the
/// option that activated it (for error reporting).
pub struct ActivatedFeature {
### core/embed/xtask/tbench/manifest.yaml
@@ -195,6 +195,28 @@ options:
when: component(firmware)
type: checkbox
+ - id: log-level
+ name: Maximum Log Level
+ description: Logging calls above this level are optimized out.
+ group: Debugging
+ type: multistate
+ states:
+ - value: "off"
+ name: "Off"
+ description: No logging.
+ - value: "error"
+ name: "Error"
+ description: Only Error level.
+ - value: "warn"
+ name: "Warning"
+ description: Only Error and Warning levels.
+ - value: "info"
+ name: "Info"
+ description: Only Error, Warning and Info levels.
+ - value: "debug"
+ name: "Debug"
+ description: All log levels enabled.
+
- id: log-external
name: External Crate Logs
description: Enable logs from dependencies that use the 'log' crate, increases code size.Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.