Skip to content

Split logger from OS. #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
veluca93 merged 1 commit into from
Dec 2, 2025
Merged

Split logger from OS. #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions pixie-uefi/src/os/logger.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
use alloc::{collections::vec_deque::VecDeque, string::String};
use core::fmt::Write;
use log::Level;
use spin::Mutex;
use uefi::{boot::ScopedProtocol, proto::console::serial::Serial};

use crate::os::{timer::Timer, UefiOS};

static MESSAGES: Mutex<VecDeque<LogEntry>> = Mutex::new(VecDeque::new());
static SERIAL: Mutex<Option<SerialWrapper>> = Mutex::new(None);

pub(super) struct LogEntry {
pub time: f64,
pub level: Level,
pub target: String,
pub msg: String,
}

struct SerialWrapper(ScopedProtocol<Serial>);

// SAFETY: There are no threads.
unsafe impl Send for SerialWrapper {}

struct Logger {}

pub(super) fn init() {
let serial = uefi::boot::find_handles::<Serial>()
.ok()
.map(|handles| uefi::boot::open_protocol_exclusive::<Serial>(handles[0]).unwrap());

*SERIAL.lock() = serial.map(SerialWrapper);

log::set_logger(&Logger {}).unwrap();
log::set_max_level(log::LevelFilter::Trace);
}

fn append_message(time: f64, level: log::Level, target: &str, msg: String) {
if let Some(serial) = &mut *SERIAL.lock() {
let style = match level {
Level::Trace => anstyle::AnsiColor::Cyan.on_default(),
Level::Debug => anstyle::AnsiColor::Blue.on_default(),
Level::Info => anstyle::AnsiColor::Green.on_default(),
Level::Warn => anstyle::AnsiColor::Yellow.on_default(),
Level::Error => anstyle::AnsiColor::Red.on_default().bold(),
};
write!(
serial.0,
"[{time:.1}s {style}{level:5}{style:#} {target}] {msg}\r\n"
)
.unwrap();
}

{
let mut logs = MESSAGES.try_lock().expect("messages are locked");
logs.push_back(LogEntry {
time,
level,
target: target.into(),
msg,
});
const MAX_MESSAGES: usize = 10;
if logs.len() > MAX_MESSAGES {
logs.pop_front();
}
}

if level <= Level::Warn {
UefiOS { cant_build: () }.force_ui_redraw()
}
}

pub(super) fn for_each_log<F: FnMut(&LogEntry)>(f: F) {
MESSAGES
.try_lock()
.expect("messages are locked")
.iter()
.for_each(f);
}

impl log::Log for Logger {
fn enabled(&self, _metadata: &log::Metadata) -> bool {
true
}

fn log(&self, record: &log::Record) {
let now = Timer::micros() as f64 * 0.000_001;
append_message(
now,
record.level(),
record.target(),
format!("{}", record.args()),
);
}

fn flush(&self) {
// no-op
}
}
98 changes: 23 additions & 75 deletions pixie-uefi/src/os/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
use alloc::boxed::Box;
use alloc::collections::VecDeque;
use alloc::string::{String, ToString};
use alloc::vec::Vec;
use core::cell::RefMut;
Expand All @@ -11,10 +10,11 @@ use core::task::Poll;

use pixie_shared::util::BytesFmt;
use uefi::boot::{EventType, ScopedProtocol, Tpl};
use uefi::proto::console::serial::Serial;
use uefi::proto::console::text::{Color, Input, Key, Output};
use uefi::{Event, Status};

use crate::os::logger::{for_each_log, LogEntry};

use self::error::Result;
use self::executor::Executor;
use self::sync::SyncRefCell;
Expand All @@ -24,6 +24,7 @@ pub mod boot_options;
pub mod disk;
pub mod error;
pub mod executor;
mod logger;
pub mod memory;
pub mod net;
pub mod sync;
Expand All @@ -32,8 +33,6 @@ mod timer;
struct UefiOSImpl {
input: ScopedProtocol<Input>,
vga: ScopedProtocol<Output>,
serial: Option<ScopedProtocol<Serial>>,
messages: VecDeque<(f64, log::Level, String, String)>,
ui_buf: Vec<(String, Color, Color)>,
ui_pos: usize,
ui_drawer: Option<Box<dyn Fn(UefiOS) + 'static>>,
Expand Down Expand Up @@ -137,10 +136,6 @@ impl UefiOS {
let input_handles = uefi::boot::find_handles::<Input>().unwrap();
let input = uefi::boot::open_protocol_exclusive::<Input>(input_handles[0]).unwrap();

let serial = uefi::boot::find_handles::<Serial>()
.ok()
.map(|handles| uefi::boot::open_protocol_exclusive::<Serial>(handles[0]).unwrap());

let vga_handles = uefi::boot::find_handles::<Output>().unwrap();
let mut vga = uefi::boot::open_protocol_exclusive::<Output>(vga_handles[0]).unwrap();

Expand All @@ -149,18 +144,14 @@ impl UefiOS {
*OS.borrow_mut() = Some(UefiOSImpl {
input,
vga,
serial,
messages: VecDeque::new(),
ui_buf: vec![],
ui_pos: 0,
ui_drawer: None,
});

let os = UefiOS { cant_build: () };

log::set_logger(&UefiOS { cant_build: () }).unwrap();
log::set_max_level(log::LevelFilter::Trace);

logger::init();
net::init();

Executor::spawn("init", async move {
Expand Down Expand Up @@ -261,20 +252,25 @@ impl UefiOS {
os.maybe_advance_to_col(cols);

// TODO(veluca): find a better solution.
let messages: Vec<_> = os.messages.iter().cloned().collect();

for (time, level, target, msg) in messages {
let fg_color = match level {
log::Level::Trace => Color::Cyan,
log::Level::Debug => Color::Blue,
log::Level::Info => Color::Green,
log::Level::Warn => Color::Yellow,
log::Level::Error => Color::Red,
};
os.write_with_color(&format!("[{time:.1}s "), Color::White, Color::Black);
os.write_with_color(&format!("{level:5}"), fg_color, Color::Black);
os.write_with_color(&format!(" {target}] {msg}\n"), Color::White, Color::Black);
}
for_each_log(
|LogEntry {
time,
level,
target,
msg,
}| {
let fg_color = match level {
log::Level::Trace => Color::Cyan,
log::Level::Debug => Color::Blue,
log::Level::Info => Color::Green,
log::Level::Warn => Color::Yellow,
log::Level::Error => Color::Red,
};
os.write_with_color(&format!("[{time:.1}s "), Color::White, Color::Black);
os.write_with_color(&format!("{level:5}"), fg_color, Color::Black);
os.write_with_color(&format!(" {target}] {msg}\n"), Color::White, Color::Black);
},
);
os.write_with_color("\n", Color::Black, Color::Black);
}
{
Expand All @@ -295,52 +291,4 @@ impl UefiOS {
pub fn set_ui_drawer<F: Fn(UefiOS) + 'static>(&self, f: F) {
self.borrow_mut().ui_drawer = Some(Box::new(f));
}

fn append_message(&self, time: f64, level: log::Level, target: &str, msg: String) {
{
let mut os = self.borrow_mut();

if let Some(serial) = &mut os.serial {
let style = match level {
log::Level::Trace => anstyle::AnsiColor::Cyan.on_default(),
log::Level::Debug => anstyle::AnsiColor::Blue.on_default(),
log::Level::Info => anstyle::AnsiColor::Green.on_default(),
log::Level::Warn => anstyle::AnsiColor::Yellow.on_default(),
log::Level::Error => anstyle::AnsiColor::Red.on_default().bold(),
};
write!(
serial,
"[{time:.1}s {style}{level:5}{style:#} {target}] {msg}\r\n"
)
.unwrap();
}

os.messages.push_back((time, level, target.into(), msg));
const MAX_MESSAGES: usize = 10;
if os.messages.len() > MAX_MESSAGES {
os.messages.pop_front();
}
}
self.force_ui_redraw();
}
}

impl log::Log for UefiOS {
fn enabled(&self, _metadata: &log::Metadata) -> bool {
true
}

fn log(&self, record: &log::Record) {
let now = Timer::micros() as f64 * 0.000_001;
self.append_message(
now,
record.level(),
record.target(),
format!("{}", record.args()),
);
}

fn flush(&self) {
// no-op
}
}