mirror of
https://github.com/saymrwulf/xous-core.git
synced 2026-11-19 09:00:54 +00:00
log-server: implement opcodes and stdout
This allows the log server to support various opcodes, and gives us stdout as a suitable command. Signed-off-by: Sean Cross <sean@xobs.io>
This commit is contained in:
parent
04055c1bf5
commit
a8e9492560
4 changed files with 155 additions and 91 deletions
|
|
@ -7,9 +7,11 @@ version = "0.1.0"
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
log = "0.4"
|
log = "0.4"
|
||||||
|
num-derive = {version = "0.3", default-features = false}
|
||||||
|
num-traits = {version = "0.2", default-features = false}
|
||||||
|
rkyv = {version = "0.4.3", features = ["const_generics"], default-features = false}
|
||||||
xous = {path = "../../xous-rs"}
|
xous = {path = "../../xous-rs"}
|
||||||
xous-ipc = {path = "../../xous-ipc"}
|
xous-ipc = {path = "../../xous-ipc"}
|
||||||
rkyv = {version = "0.4.3", features = ["const_generics"], default-features = false}
|
|
||||||
|
|
||||||
[build-dependencies]
|
[build-dependencies]
|
||||||
vergen = "3"
|
vergen = "3"
|
||||||
|
|
|
||||||
|
|
@ -6,3 +6,62 @@ pub struct LogRecord {
|
||||||
pub level: u32,
|
pub level: u32,
|
||||||
pub args: xous_ipc::String<2800>,
|
pub args: xous_ipc::String<2800>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, PartialEq, num_derive::FromPrimitive, num_derive::ToPrimitive)]
|
||||||
|
pub enum Opcode {
|
||||||
|
/// A `LogRecord` message, delivering structured log output
|
||||||
|
LogRecord = 0,
|
||||||
|
|
||||||
|
/// A `xous::String` destined for stdout
|
||||||
|
StandardOutput = 1,
|
||||||
|
|
||||||
|
/// A `xous::String` destined for stderr
|
||||||
|
StandardError = 2,
|
||||||
|
|
||||||
|
/// A `xous::String` containing this program's name
|
||||||
|
ProgramName = 3,
|
||||||
|
|
||||||
|
/// A panic occurred, and a panic log is forthcoming
|
||||||
|
PanicStarted = 1000,
|
||||||
|
|
||||||
|
/// Log messages of varying size
|
||||||
|
PanicMessage0 = 1100,
|
||||||
|
PanicMessage1 = 1101,
|
||||||
|
PanicMessage2 = 1102,
|
||||||
|
PanicMessage3 = 1103,
|
||||||
|
PanicMessage4 = 1104,
|
||||||
|
PanicMessage5 = 1105,
|
||||||
|
PanicMessage6 = 1106,
|
||||||
|
PanicMessage7 = 1107,
|
||||||
|
PanicMessage8 = 1108,
|
||||||
|
PanicMessage9 = 1109,
|
||||||
|
PanicMessage10 = 1110,
|
||||||
|
PanicMessage11 = 1111,
|
||||||
|
PanicMessage12 = 1112,
|
||||||
|
PanicMessage13 = 1113,
|
||||||
|
PanicMessage14 = 1114,
|
||||||
|
PanicMessage15 = 1115,
|
||||||
|
PanicMessage16 = 1116,
|
||||||
|
PanicMessage17 = 1117,
|
||||||
|
PanicMessage18 = 1118,
|
||||||
|
PanicMessage19 = 1119,
|
||||||
|
PanicMessage20 = 1120,
|
||||||
|
PanicMessage21 = 1121,
|
||||||
|
PanicMessage22 = 1122,
|
||||||
|
PanicMessage23 = 1123,
|
||||||
|
PanicMessage24 = 1124,
|
||||||
|
PanicMessage25 = 1125,
|
||||||
|
PanicMessage26 = 1126,
|
||||||
|
PanicMessage27 = 1127,
|
||||||
|
PanicMessage28 = 1128,
|
||||||
|
PanicMessage29 = 1129,
|
||||||
|
PanicMessage30 = 1130,
|
||||||
|
PanicMessage31 = 1131,
|
||||||
|
PanicMessage32 = 1132,
|
||||||
|
|
||||||
|
/// End of a panic
|
||||||
|
PanicFinished = 1200,
|
||||||
|
|
||||||
|
/// Enable receiving messages when the system is resumed from sleep.
|
||||||
|
EnableRx = 2000,
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
#![cfg_attr(target_os = "none", no_std)]
|
#![cfg_attr(target_os = "none", no_std)]
|
||||||
use core::fmt::Write;
|
use core::fmt::Write;
|
||||||
use core::sync::atomic::{AtomicBool, Ordering};
|
use core::sync::atomic::{AtomicBool, Ordering};
|
||||||
|
use num_traits::ToPrimitive;
|
||||||
use xous_ipc::{Buffer, String};
|
use xous_ipc::{Buffer, String};
|
||||||
|
|
||||||
pub mod api;
|
pub mod api;
|
||||||
|
|
@ -65,12 +66,16 @@ impl XousLoggerBacking<'_> {
|
||||||
};
|
};
|
||||||
|
|
||||||
self.buffer.rewrite(lr).unwrap();
|
self.buffer.rewrite(lr).unwrap();
|
||||||
self.buffer.lend(self.conn, 0).unwrap(); // there is only one type of buffer we should be sending!
|
self.buffer
|
||||||
|
.lend(self.conn, crate::api::Opcode::LogRecord.to_u32().unwrap())
|
||||||
|
.unwrap();
|
||||||
}
|
}
|
||||||
fn resume(&self) {
|
fn resume(&self) {
|
||||||
xous::send_message(self.conn,
|
xous::send_message(
|
||||||
xous::Message::new_scalar(2000, 0, 0, 0, 0) // logger is one of the few servers that uses special, non-encoded message IDs.
|
self.conn,
|
||||||
).expect("couldn't send resume message to the logger implementation");
|
xous::Message::new_scalar(2000, 0, 0, 0, 0), // logger is one of the few servers that uses special, non-encoded message IDs.
|
||||||
|
)
|
||||||
|
.expect("couldn't send resume message to the logger implementation");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ use api::*;
|
||||||
mod debug;
|
mod debug;
|
||||||
|
|
||||||
use core::fmt::Write;
|
use core::fmt::Write;
|
||||||
use xous_ipc::String;
|
use num_traits::FromPrimitive;
|
||||||
|
|
||||||
#[cfg(not(target_os = "none"))]
|
#[cfg(not(target_os = "none"))]
|
||||||
mod implementation {
|
mod implementation {
|
||||||
|
|
@ -233,7 +233,7 @@ fn handle_scalar(
|
||||||
#[cfg(target_os = "none")]
|
#[cfg(target_os = "none")]
|
||||||
crate::debug::DEFAULT.enable_rx();
|
crate::debug::DEFAULT.enable_rx();
|
||||||
writeln!(output, "Resuming logger").unwrap();
|
writeln!(output, "Resuming logger").unwrap();
|
||||||
},
|
}
|
||||||
_ => writeln!(
|
_ => writeln!(
|
||||||
output,
|
output,
|
||||||
"Unrecognized scalar message from {}: {:#?}",
|
"Unrecognized scalar message from {}: {:#?}",
|
||||||
|
|
@ -243,17 +243,79 @@ fn handle_scalar(
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn handle_opcode(
|
||||||
|
output: &mut implementation::OutputWriter,
|
||||||
|
sender: xous::MessageSender,
|
||||||
|
opcode: api::Opcode,
|
||||||
|
message: &xous::Message,
|
||||||
|
) {
|
||||||
|
if let Some(mem) = message.memory_message() {
|
||||||
|
match opcode {
|
||||||
|
api::Opcode::LogRecord => {
|
||||||
|
let buffer = unsafe { xous_ipc::Buffer::from_memory_message(mem) };
|
||||||
|
let lr: LogRecord = buffer.to_original::<LogRecord, _>().unwrap();
|
||||||
|
let level = if log::Level::Error as u32 == lr.level {
|
||||||
|
"ERR "
|
||||||
|
} else if log::Level::Warn as u32 == lr.level {
|
||||||
|
"WARN"
|
||||||
|
} else if log::Level::Info as u32 == lr.level {
|
||||||
|
"INFO"
|
||||||
|
} else if log::Level::Debug as u32 == lr.level {
|
||||||
|
"DBG "
|
||||||
|
} else if log::Level::Trace as u32 == lr.level {
|
||||||
|
"TRCE"
|
||||||
|
} else {
|
||||||
|
"UNKNOWN"
|
||||||
|
};
|
||||||
|
if let Some(line) = lr.line {
|
||||||
|
writeln!(
|
||||||
|
output,
|
||||||
|
"{}:{}: {} ({}:{})",
|
||||||
|
level, lr.module, lr.args, lr.file, line
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
} else {
|
||||||
|
writeln!(output, "{}:{}: {} ({})", level, lr.module, lr.args, lr.file).unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
api::Opcode::StandardOutput | api::Opcode::StandardError => {
|
||||||
|
let string = unsafe { xous::stringbuffer::StringBuffer::from_memory_message(mem) };
|
||||||
|
write!(output, "{}", string).unwrap();
|
||||||
|
}
|
||||||
|
_ => {
|
||||||
|
writeln!(output, "Unhandled opcode").unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else if let Some(scalar) = message.scalar_message() {
|
||||||
|
// Scalar message
|
||||||
|
handle_scalar(output, sender, scalar, sender.pid().unwrap());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
fn reader_thread(arg: usize) {
|
fn reader_thread(arg: usize) {
|
||||||
let mut output = unsafe { &mut *(arg as *mut implementation::OutputWriter) };
|
let output = unsafe { &mut *(arg as *mut implementation::OutputWriter) };
|
||||||
writeln!(output, "LOG: Xous Logging Server starting up...").unwrap();
|
writeln!(output, "LOG: Xous Logging Server starting up...").unwrap();
|
||||||
|
|
||||||
writeln!(output, "LOG: ****************************************************************").unwrap();
|
writeln!(
|
||||||
writeln!(output, "LOG: *** Welcome to Xous {:40} ***", env!("VERGEN_SHA")).unwrap();
|
output,
|
||||||
|
"LOG: ****************************************************************"
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
writeln!(
|
||||||
|
output,
|
||||||
|
"LOG: *** Welcome to Xous {:40} ***",
|
||||||
|
env!("VERGEN_SHA")
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
// time stamp isn't actually the time stamp of the build, unfortunately. It's the time stamp of the
|
// time stamp isn't actually the time stamp of the build, unfortunately. It's the time stamp of the
|
||||||
// last time you managed to force a rebuild that also causes log-server to be rebuilt, not necessarily
|
// last time you managed to force a rebuild that also causes log-server to be rebuilt, not necessarily
|
||||||
// capturing the build time of the very most recent change!
|
// capturing the build time of the very most recent change!
|
||||||
// writeln!(output, "LOG: *** Built: {:49} ***", env!("VERGEN_BUILD_TIMESTAMP")).unwrap();
|
// writeln!(output, "LOG: *** Built: {:49} ***", env!("VERGEN_BUILD_TIMESTAMP")).unwrap();
|
||||||
writeln!(output, "LOG: ****************************************************************").unwrap();
|
writeln!(
|
||||||
|
output,
|
||||||
|
"LOG: ****************************************************************"
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
println!("LOG: my PID is {}", xous::process::id());
|
println!("LOG: my PID is {}", xous::process::id());
|
||||||
let server_addr = xous::create_server_with_address(b"xous-log-server ").unwrap();
|
let server_addr = xous::create_server_with_address(b"xous-log-server ").unwrap();
|
||||||
writeln!(output, "LOG: Server listening on address {:?}", server_addr).unwrap();
|
writeln!(output, "LOG: Server listening on address {:?}", server_addr).unwrap();
|
||||||
|
|
@ -265,86 +327,18 @@ fn reader_thread(arg: usize) {
|
||||||
}
|
}
|
||||||
counter += 1;
|
counter += 1;
|
||||||
// writeln!(output, "LOG: Waiting for an event...").unwrap();
|
// writeln!(output, "LOG: Waiting for an event...").unwrap();
|
||||||
let mut envelope =
|
let envelope = xous::syscall::receive_message(server_addr).expect("couldn't get address");
|
||||||
xous::syscall::receive_message(server_addr).expect("couldn't get address");
|
|
||||||
let sender = envelope.sender;
|
let sender = envelope.sender;
|
||||||
// writeln!(output, "LOG: Got message envelope: {:?}", envelope).unwrap();
|
if let Some(opcode) = FromPrimitive::from_usize(envelope.body.id()) {
|
||||||
match &mut envelope.body {
|
handle_opcode(output, sender, opcode, &envelope.body);
|
||||||
xous::Message::Scalar(msg) =>
|
} else {
|
||||||
handle_scalar(&mut output, sender, msg, envelope.sender.pid().unwrap()),
|
writeln!(
|
||||||
xous::Message::BlockingScalar(msg) => {
|
output,
|
||||||
writeln!(
|
"Unrecognized opcode from process {}: {}",
|
||||||
output,
|
sender.pid().map(|v| v.get()).unwrap_or_default(),
|
||||||
"LOG: BlockingScalar message from {}: {:?}",
|
envelope.body.id()
|
||||||
envelope.sender, msg
|
)
|
||||||
)
|
.unwrap();
|
||||||
.unwrap();
|
|
||||||
}
|
|
||||||
xous::Message::Move(msg) => {
|
|
||||||
String::<4000>::from_message(msg)
|
|
||||||
.map(|log_entry: String<4000>| {
|
|
||||||
writeln!(
|
|
||||||
output,
|
|
||||||
"LOG: Moved log message from {}: {}",
|
|
||||||
sender, log_entry
|
|
||||||
)
|
|
||||||
.unwrap()
|
|
||||||
})
|
|
||||||
.or_else(|e| {
|
|
||||||
writeln!(output, "LOG: unable to convert Move message to str: {}", e)
|
|
||||||
})
|
|
||||||
.ok();
|
|
||||||
}
|
|
||||||
xous::Message::Borrow(_msg) => {
|
|
||||||
let mem = envelope.body.memory_message().unwrap();
|
|
||||||
let buffer = unsafe { xous_ipc::Buffer::from_memory_message(mem) };
|
|
||||||
let lr: LogRecord = buffer.to_original::<LogRecord, _>().unwrap();
|
|
||||||
let level =
|
|
||||||
if log::Level::Error as u32 == lr.level {
|
|
||||||
"ERR " }
|
|
||||||
else if log::Level::Warn as u32 == lr.level {
|
|
||||||
"WARN" }
|
|
||||||
else if log::Level::Info as u32 == lr.level {
|
|
||||||
"INFO" }
|
|
||||||
else if log::Level::Debug as u32 == lr.level {
|
|
||||||
"DBG " }
|
|
||||||
else if log::Level::Trace as u32 == lr.level {
|
|
||||||
"TRCE" }
|
|
||||||
else {
|
|
||||||
"UNKNOWN"
|
|
||||||
};
|
|
||||||
if let Some(line)= lr.line {
|
|
||||||
writeln!(output, "{}:{}: {} ({}:{})",
|
|
||||||
level, lr.module, lr.args, lr.file, line
|
|
||||||
).unwrap();
|
|
||||||
} else {
|
|
||||||
writeln!(output, "{}:{}: {} ({})",
|
|
||||||
level, lr.module, lr.args, lr.file
|
|
||||||
).unwrap();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
xous::Message::MutableBorrow(msg) => {
|
|
||||||
String::<4000>::from_message(msg)
|
|
||||||
.map(|mut log_entry: String<4000>| {
|
|
||||||
writeln!(
|
|
||||||
output,
|
|
||||||
"LOG: Mutable borrowed log message from {} len {}:\n\r {}\n\r",
|
|
||||||
sender,
|
|
||||||
log_entry.len(),
|
|
||||||
log_entry,
|
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
writeln!(log_entry, " << HELLO FROM THE SERVER").unwrap();
|
|
||||||
})
|
|
||||||
.or_else(|e| {
|
|
||||||
writeln!(
|
|
||||||
output,
|
|
||||||
"LOG: unable to convert MutableBorrow message to str: {}",
|
|
||||||
e
|
|
||||||
)
|
|
||||||
})
|
|
||||||
.ok();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
/* // all cases handled, this loop can never exit
|
/* // all cases handled, this loop can never exit
|
||||||
|
|
@ -378,7 +372,11 @@ fn some_main() -> ! {
|
||||||
let mut writer = output.get_writer();
|
let mut writer = output.get_writer();
|
||||||
println!("LOG: my PID is {}", xous::process::id());
|
println!("LOG: my PID is {}", xous::process::id());
|
||||||
println!("LOG: Creating the reader thread");
|
println!("LOG: Creating the reader thread");
|
||||||
xous::create_thread_1(reader_thread, &mut writer as *mut implementation::OutputWriter as usize).unwrap();
|
xous::create_thread_1(
|
||||||
|
reader_thread,
|
||||||
|
&mut writer as *mut implementation::OutputWriter as usize,
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
println!("LOG: Running the output");
|
println!("LOG: Running the output");
|
||||||
output.run();
|
output.run();
|
||||||
panic!("LOG: Exited");
|
panic!("LOG: Exited");
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue