refactor(core/rust): move log crate connector to sys
What changed, and why it matters
This commit is a straightforward internal code reorganization (refactor) for how debug logging is wired up in the Trezor firmware's Rust code. It moves a logging connector from one internal module to another and adds a build-time feature flag to enable it. There is no indication this fixes or introduces a security vulnerability.
No security action required. Treat as normal maintenance/refactor. If reviewing for defense in depth, verify that the `log_external` feature remains disabled in production/release builds, since enabling it could increase code size and potentially expose additional debug output surfaces.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The change relocates the log crate connector from core/embed/rust/src/util/logger into core/embed/sys/src/log_external, renames the initialization function, and makes it an optional Cargo feature (log_external) controlled via project.toml build options. The Python-facing trezorlog.init() signature drops its level argument and now always initializes external logging at Trace level when the feature is enabled. The previous workspace-level log crate default features (max_level_trace, release_max_level_off) are removed, shifting control to the new feature flag. No functional security behavior is altered.
Changed components
core/embed/rust/src/lib.rscore/embed/rust/src/micropython/logging.rscore/embed/rust/src/util/mod.rscore/embed/sys/Cargo.tomlcore/embed/sys/src/lib.rscore/embed/sys/src/log_external.rscore/embed/sys/src/syslog.rscore/embed/Cargo.tomlcore/embed/Cargo.lockcore/embed/projects/*/project.tomlcore/embed/xtask/presets.tomlcore/embed/xtask/src/options.rscore/embed/xtask/tbench/manifest.yamlcore/mocks/generated/trezorlog.pyicore/src/trezor/log.pyInspect captured patch +47 / −27
### core/embed/Cargo.lock
@@ -906,6 +906,7 @@ dependencies = [
"color-eyre",
"crypto",
"cty",
+ "log",
"models",
"rtl",
"spin",
### core/embed/Cargo.toml
@@ -69,7 +69,7 @@ cfg-if = "1.0"
cty = "0.2.2"
easer = { version = "0.3.0", default-features = false, features = ["libm"] }
heapless = { version = "0.9.2", features = ["ufmt"], default-features = false }
-log = { version = "0.4.29", features = ["max_level_trace", "release_max_level_off"] }
+log = { version = "0.4.29" }
minicbor = { version = "1.0.0", default-features = false }
num-derive = "0.4.2"
num-traits = { version = "0.2.19", default-features = false, features = ["libm"] }
### core/embed/projects/boardloader/project.toml
@@ -27,3 +27,4 @@ asan = { true = ["asan"] }
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"] }
### core/embed/projects/bootloader/project.toml
@@ -52,5 +52,6 @@ bootloader-devel = { true = ["bootloader_devel"] }
dbg-console = { vcp = ["dbg_console_vcp"], swo = ["dbg_console_swo"], system-view = ["dbg_console_system_view"] }
debug-link = { true = ["debuglink", "ui_debug"] }
disable-animation = { true = ["disable_animation"] }
+log-external = { true = ["sys/log_external"] }
perf-overlay = { true = ["ui_performance_overlay"] }
production = { true = ["production"] }
### core/embed/projects/bootloader_ci/project.toml
@@ -34,4 +34,5 @@ elf_sections = [".header", ".flash", ".data"]
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"] }
production = { true = ["production"] }
### core/embed/projects/firmware/project.toml
@@ -67,6 +67,7 @@ debug-link = { true = ["debuglink", "ui_debug"] }
disable-animation = { true = ["disable_animation"] }
force-bootloader-upgrade = { true = ["force_bootloader_upgrade"] }
frozen = { true = ["frozen"] }
+log-external = { true = ["sys/log_external"] }
log-stack-usage = { true = ["log_stack_usage"] }
mem-perf = { true = ["memperf"] }
miniscript = { true = ["miniscript"] }
### core/embed/projects/kernel/project.toml
@@ -52,6 +52,7 @@ btc-only = { false = ["universal_fw"] }
dbg-console = { vcp = ["dbg_console_vcp"], swo = ["dbg_console_swo"], system-view = ["dbg_console_system_view"] }
debug-link = { true = ["debuglink"] }
force-bootloader-upgrade = { true = ["force_bootloader_upgrade"] }
+log-external = { true = ["sys/log_external"] }
n1w1 = { true = ["nfc"] } # TODO: move back to `uses` section (after stabilization)
production = { true = ["production"] }
pyopt = { false = ["optiga_testing"] }
### core/embed/projects/prodtest/project.toml
@@ -59,5 +59,6 @@ asan = { true = ["asan"] }
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"] }
perf-overlay = { true = ["ui_performance_overlay"] }
production = { true = ["production"] }
### core/embed/projects/secmon/project.toml
@@ -29,6 +29,7 @@ asan = { true = ["asan"] }
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"] }
production = { true = ["production"] }
pyopt = { false = ["optiga_testing"] }
storage-insecure-testing-mode = { true = ["storage_insecure_testing_mode"] }
### core/embed/rust/src/lib.rs
@@ -91,7 +91,7 @@ pub fn main() -> i32 {
}
match std::env::var("RUST_LOG") {
- Ok(s) if s != "0" => crate::util::logger::init_rust_logging(0),
+ Ok(s) if s != "0" => sys::syslog::init_external_logging(),
_ => eprintln!("Set RUST_LOG=1 to enable logs."),
}
### core/embed/rust/src/micropython/logging.rs
@@ -1,11 +1,10 @@
-use sys::syslog::{log, LogLevel};
+use sys::syslog::{init_external_logging, log, LogLevel};
use crate::micropython::buffer::StrBuffer;
use crate::micropython::map::Map;
use crate::micropython::module::Module;
use crate::micropython::qstr::Qstr;
use crate::micropython::{util, Error, Obj};
-use crate::util::logger::init_rust_logging;
fn _log(level: LogLevel, args: &[Obj], kwargs: &Map) -> Result<Obj, Error> {
let [module, fmt, fmt_args @ ..] = args else {
@@ -66,9 +65,9 @@ extern "C" fn py_error(n_args: usize, args: *const Obj, kwargs: *mut Map) -> Obj
Obj::const_none()
}
-extern "C" fn py_init(level: Obj) -> Obj {
+extern "C" fn py_init() -> Obj {
let block = || {
- init_rust_logging(level.try_into()?);
+ init_external_logging();
Ok(())
};
unsafe {
@@ -100,9 +99,9 @@ pub static mp_module_trezorlog: Module = obj_module! {
/// ...
Qstr::MP_QSTR_error => obj_fn_kw!(2, py_error).as_obj(),
- /// def init(level: int) -> None:
+ /// def init() -> None:
/// """
/// Initialize Rust logging connector.
/// """
- Qstr::MP_QSTR_init => obj_fn_1!(py_init).as_obj(),
+ Qstr::MP_QSTR_init => obj_fn_0!(py_init).as_obj(),
};
### core/embed/rust/src/util/mod.rs
@@ -1,4 +1,2 @@
#[cfg(feature = "micropython")]
pub mod interpolate;
-#[cfg(feature = "dbg_console")]
-pub mod logger;
### core/embed/sys/Cargo.toml
@@ -13,6 +13,7 @@ xbuild.workspace = true
crypto.workspace = true
cty.workspace = true
rtl.workspace = true
+log = { workspace = true, optional = true }
models.workspace = true
spin.workspace = true
ufmt.workspace = true
@@ -53,6 +54,7 @@ emulator = ["rtl/emulator", "crypto/emulator"]
i2c_bus = []
ipc = []
lockable_bootloader = []
+log_external = ["log"]
production = ["rtl/production"]
pvd = []
rtc = []
### core/embed/sys/src/lib.rs
@@ -16,4 +16,8 @@ pub mod sysevent;
#[cfg(feature = "dbg_console")]
pub mod syslog;
pub mod task;
+
+#[cfg(all(feature = "dbg_console", feature = "log_external"))]
+pub mod log_external;
+
pub mod time;
### core/embed/sys/src/log_external.rs
@@ -1,11 +1,13 @@
//! Connects the `log::error!`, `log::warn!`, ... macros from the `log` crate to
-//! our C logging backend.
+//! our C logging backend. Useful mainly with third-party crates, for internal
+//! use sys::ufmt is preferred.
use core::fmt::Write as _;
use core::sync::atomic::{AtomicBool, Ordering};
-use log::{set_logger, set_max_level, Level, LevelFilter, Log, Metadata, Record};
-use sys::syslog;
+use log::{Level, LevelFilter, Log, Metadata, Record, set_logger, set_max_level};
+
+use crate::syslog;
static INITIALIZED: AtomicBool = AtomicBool::new(false);
@@ -42,19 +44,9 @@ impl Log for SysLogger {
fn flush(&self) {}
}
-fn to_filter(val: u8) -> LevelFilter {
- match val {
- 0 => LevelFilter::Trace, // corresponds to debug in micropython
- 1 => LevelFilter::Info,
- 2 => LevelFilter::Warn,
- 3 => LevelFilter::Error,
- _ => LevelFilter::Off,
- }
-}
-
-pub fn init_rust_logging(level: u8) {
+pub fn init() {
if !INITIALIZED.swap(true, Ordering::Relaxed) {
let _ = set_logger(&SysLogger);
- set_max_level(to_filter(level));
+ set_max_level(LevelFilter::Trace);
}
}
### core/embed/sys/src/syslog.rs
@@ -94,3 +94,8 @@ pub fn log_simple(module: &str, level: LogLevel, message: &str) {
syslog_write_chunk(message, true).ok();
}
}
+
+pub fn init_external_logging() {
+ #[cfg(feature = "log_external")]
+ crate::log_external::init()
+}
### 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-external = true
[[defaults]]
when = { emulator = false }
### core/embed/xtask/src/options.rs
@@ -186,6 +186,10 @@ build_options! {
#[arg(long, num_args = 0..=1, default_missing_value = "true")]
map source_lines: bool,
+ /// Enable logging via 'log' crate
+ #[arg(long, num_args = 0..=1, default_missing_value = "false")]
+ map log_external: bool,
+
/// Optimize MicroPython bytecode
#[arg(long, num_args = 0..=1, default_missing_value = "true", overrides_with = "pyopt")]
map pyopt: bool,
### core/embed/xtask/tbench/manifest.yaml
@@ -195,6 +195,13 @@ options:
when: component(firmware)
type: checkbox
+ - id: log-external
+ name: External Crate Logs
+ description: Enable logs from dependencies that use the 'log' crate, increases code size.
+ group: Debugging
+ when: component(firmware)
+ type: checkbox
+
- id: frozen
name: Frozen Modules
description: Embeds frozen MicroPython modules.
### core/mocks/generated/trezorlog.pyi
@@ -23,7 +23,7 @@ def error(name: str, msg: str, *args: Any, *, iface: WireInterface | None = None
# rust/src/micropython/logging.rs
-def init(level: int) -> None:
+def init() -> None:
"""
Initialize Rust logging connector.
"""
### core/src/trezor/log.py
@@ -18,7 +18,7 @@ def _no_op(name: str, msg: str, *args: Any, iface: WireInterface | None = None)
_levels = [debug, info, warning, error]
_min_level = 0 # can be used for manually disabling low-priority logging levels
debug, info, warning, error = [_no_op] * _min_level + _levels[_min_level:]
- init(_min_level) # initialize rust logging connector
+ init() # initialize rust logging connector
else:
debug = warning = info = error = _no_op
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.