use crate::{
identity::ComponentIdentity,
logs::{error::LogsError, stats::LogStreamStats, stored_message::DebugLogStoredMessage},
};
use diagnostics_data::{BuilderArgs, LogsData, LogsDataBuilder, Severity};
use fidl::prelude::*;
use fidl_fuchsia_boot::ReadOnlyLogMarker;
use fuchsia_async as fasync;
use fuchsia_component::client::connect_to_protocol;
use fuchsia_zircon as zx;
use futures::stream::{unfold, Stream};
use lazy_static::lazy_static;
use moniker::ExtendedMoniker;
use std::{future::Future, sync::Arc};
pub const KERNEL_URL: &str = "fuchsia-boot://kernel";
lazy_static! {
pub static ref KERNEL_IDENTITY: Arc<ComponentIdentity> = {
Arc::new(ComponentIdentity::new(ExtendedMoniker::parse_str("./klog").unwrap(), KERNEL_URL))
};
}
pub trait DebugLog {
fn read(&self) -> Result<zx::sys::zx_log_record_t, zx::Status>;
fn ready_signal(&self) -> impl Future<Output = Result<(), zx::Status>> + Send;
}
pub struct KernelDebugLog {
debuglogger: zx::DebugLog,
}
impl DebugLog for KernelDebugLog {
fn read(&self) -> Result<zx::sys::zx_log_record_t, zx::Status> {
self.debuglogger.read()
}
async fn ready_signal(&self) -> Result<(), zx::Status> {
fasync::OnSignals::new(&self.debuglogger, zx::Signals::LOG_READABLE).await?;
Ok(())
}
}
impl KernelDebugLog {
pub async fn new() -> Result<Self, LogsError> {
let boot_log = connect_to_protocol::<ReadOnlyLogMarker>().map_err(|source| {
LogsError::ConnectingToService { protocol: ReadOnlyLogMarker::PROTOCOL_NAME, source }
})?;
let debuglogger =
boot_log.get().await.map_err(|source| LogsError::RetrievingDebugLog { source })?;
Ok(KernelDebugLog { debuglogger })
}
}
pub struct DebugLogBridge<K: DebugLog> {
debug_log: K,
stats: Arc<LogStreamStats>,
}
impl<K: DebugLog> DebugLogBridge<K> {
pub fn create(debug_log: K, stats: Arc<LogStreamStats>) -> Self {
DebugLogBridge { debug_log, stats }
}
fn read_log(&mut self) -> Result<DebugLogStoredMessage, zx::Status> {
let record = self.debug_log.read()?;
Ok(DebugLogStoredMessage::new(record, Arc::clone(&self.stats)))
}
pub fn existing_logs(&mut self) -> Result<Vec<DebugLogStoredMessage>, zx::Status> {
let mut result = vec![];
loop {
match self.read_log() {
Err(zx::Status::SHOULD_WAIT) => break,
Err(err) => return Err(err),
Ok(log) => result.push(log),
}
}
Ok(result)
}
pub fn listen(self) -> impl Stream<Item = Result<DebugLogStoredMessage, zx::Status>> {
unfold((true, self), move |(mut is_readable, mut klogger)| async move {
loop {
if !is_readable {
if let Err(e) = klogger.debug_log.ready_signal().await {
break Some((Err(e), (is_readable, klogger)));
}
}
is_readable = true;
match klogger.read_log() {
Err(zx::Status::SHOULD_WAIT) => {
is_readable = false;
continue;
}
x => break Some((x, (is_readable, klogger))),
}
}
})
}
}
pub fn convert_debuglog_to_log_message(record: &zx::sys::zx_log_record_t) -> Option<LogsData> {
let data_len = record.datalen as usize;
let mut contents = String::from_utf8_lossy(&record.data[0..data_len]).into_owned();
if let Some(b'\n') = contents.bytes().last() {
contents.pop();
}
const MAX_STRING_SEARCH_SIZE: usize = 100;
let last = contents
.char_indices()
.nth(MAX_STRING_SEARCH_SIZE)
.map(|(i, _)| i)
.unwrap_or(contents.len());
let early_contents = &contents[..last];
let severity = match record.severity {
0x10 => Severity::Trace,
0x20 => Severity::Debug,
0x40 => Severity::Warn,
0x50 => Severity::Error,
0x60 => Severity::Fatal,
_ => {
if early_contents.contains("ERROR:") {
Severity::Error
} else if early_contents.contains("WARNING:") {
Severity::Warn
} else {
Severity::Info
}
}
};
Some(
LogsDataBuilder::new(BuilderArgs {
timestamp_nanos: record.timestamp.into(),
component_url: Some(KERNEL_IDENTITY.url.to_string()),
moniker: KERNEL_IDENTITY.to_string(),
severity,
})
.set_pid(record.pid)
.set_tid(record.tid)
.add_tag("klog".to_string())
.set_dropped(0)
.set_message(contents)
.build(),
)
}
#[cfg(test)]
mod tests {
use super::*;
use crate::logs::{stored_message::StoredMessage, testing::*};
use fidl_fuchsia_diagnostics as fdiagnostics;
use fidl_fuchsia_logger::LogMessage;
use futures::stream::{StreamExt, TryStreamExt};
#[fuchsia::test]
fn convert_debuglog_to_log_message_test() {
let klog = TestDebugEntry::new("test log".as_bytes());
let data = convert_debuglog_to_log_message(&klog.record).unwrap();
assert_eq!(
data,
LogsDataBuilder::new(BuilderArgs {
timestamp_nanos: klog.record.timestamp.into(),
component_url: Some(KERNEL_IDENTITY.url.to_string()),
moniker: KERNEL_IDENTITY.to_string(),
severity: Severity::Info,
})
.set_pid(klog.record.pid)
.set_tid(klog.record.tid)
.add_tag("klog")
.set_message("test log".to_string())
.build()
);
let log_message: LogMessage = data.into();
assert_eq!(
log_message,
LogMessage {
pid: klog.record.pid,
tid: klog.record.tid,
time: klog.record.timestamp,
severity: fdiagnostics::Severity::Info.into_primitive() as i32,
dropped_logs: 0,
tags: vec!["klog".to_string()],
msg: "test log".to_string(),
}
);
let klog = TestDebugEntry::new(&vec![b'a'; zx::sys::ZX_LOG_RECORD_DATA_MAX]);
let data = convert_debuglog_to_log_message(&klog.record).unwrap();
assert_eq!(
data,
LogsDataBuilder::new(BuilderArgs {
timestamp_nanos: klog.record.timestamp.into(),
component_url: Some(KERNEL_IDENTITY.url.to_string()),
moniker: KERNEL_IDENTITY.to_string(),
severity: Severity::Info,
})
.set_pid(klog.record.pid)
.set_tid(klog.record.tid)
.add_tag("klog")
.set_message(String::from_utf8(vec![b'a'; zx::sys::ZX_LOG_RECORD_DATA_MAX]).unwrap())
.build()
);
let klog = TestDebugEntry::new(&[]);
let data = convert_debuglog_to_log_message(&klog.record).unwrap();
assert_eq!(
data,
LogsDataBuilder::new(BuilderArgs {
timestamp_nanos: klog.record.timestamp.into(),
component_url: Some(KERNEL_IDENTITY.url.to_string()),
moniker: KERNEL_IDENTITY.to_string(),
severity: Severity::Info,
})
.set_pid(klog.record.pid)
.set_tid(klog.record.tid)
.add_tag("klog")
.set_message("".to_string())
.build()
);
let klog = TestDebugEntry::new(b"\x00\x9f\x92");
assert_eq!(convert_debuglog_to_log_message(&klog.record).unwrap().msg().unwrap(), "\x00��");
}
#[fuchsia::test]
fn logger_existing_logs_test() {
let debug_log = TestDebugLog::default();
let klog = TestDebugEntry::new("test log".as_bytes());
debug_log.enqueue_read_entry(&klog);
debug_log.enqueue_read_fail(zx::Status::SHOULD_WAIT);
let mut log_bridge = DebugLogBridge::create(debug_log, Default::default());
assert_eq!(
log_bridge
.existing_logs()
.unwrap()
.into_iter()
.map(|m| m.parse(&KERNEL_IDENTITY).unwrap())
.collect::<Vec<_>>(),
vec![LogsDataBuilder::new(BuilderArgs {
timestamp_nanos: klog.record.timestamp.into(),
component_url: Some(KERNEL_IDENTITY.url.to_string()),
moniker: KERNEL_IDENTITY.to_string(),
severity: Severity::Info,
})
.set_pid(klog.record.pid)
.set_tid(klog.record.tid)
.add_tag("klog")
.set_message("test log".to_string())
.build()]
);
let debug_log = TestDebugLog::default();
let malformed_klog = TestDebugEntry::new(b"\x80");
debug_log.enqueue_read_entry(&malformed_klog);
debug_log.enqueue_read_fail(zx::Status::SHOULD_WAIT);
let mut log_bridge = DebugLogBridge::create(debug_log, Default::default());
assert!(!log_bridge.existing_logs().unwrap().is_empty());
}
#[fasync::run_until_stalled(test)]
async fn logger_keep_listening_after_exhausting_initial_contents_test() {
let debug_log = TestDebugLog::default();
debug_log.enqueue_read_entry(&TestDebugEntry::new("test log".as_bytes()));
debug_log.enqueue_read_fail(zx::Status::SHOULD_WAIT);
debug_log.enqueue_read_entry(&TestDebugEntry::new("second test log".as_bytes()));
let log_bridge = DebugLogBridge::create(debug_log, Default::default());
let mut log_stream =
Box::pin(log_bridge.listen()).map(|r| r.unwrap().parse(&KERNEL_IDENTITY));
let log_message = log_stream.try_next().await.unwrap().unwrap();
assert_eq!(log_message.msg().unwrap(), "test log");
let log_message = log_stream.try_next().await.unwrap().unwrap();
assert_eq!(log_message.msg().unwrap(), "second test log");
let debug_log = TestDebugLog::default();
let malformed_klog = TestDebugEntry::new(b"\x80");
debug_log.enqueue_read_entry(&malformed_klog);
debug_log.enqueue_read_entry(&TestDebugEntry::new("test log".as_bytes()));
let log_bridge = DebugLogBridge::create(debug_log, Default::default());
let mut log_stream = Box::pin(log_bridge.listen());
let log_message =
log_stream.try_next().await.unwrap().unwrap().parse(&KERNEL_IDENTITY).unwrap();
assert_eq!(log_message.msg().unwrap(), "�");
}
#[fasync::run_until_stalled(test)]
async fn severity_parsed_from_log() {
let debug_log = TestDebugLog::default();
debug_log.enqueue_read_entry(&TestDebugEntry::new("ERROR: first log".as_bytes()));
debug_log.enqueue_read_entry(&TestDebugEntry::new("first log error".as_bytes()));
debug_log.enqueue_read_entry(&TestDebugEntry::new("WARNING: second log".as_bytes()));
debug_log.enqueue_read_entry(&TestDebugEntry::new("INFO: third log".as_bytes()));
debug_log.enqueue_read_entry(&TestDebugEntry::new("fourth log".as_bytes()));
debug_log.enqueue_read_entry(&TestDebugEntry::new_with_severity(
"ERROR: severity takes precedence over msg when not info".as_bytes(),
0x40, ));
let long_padding = (0..100).map(|_| "\u{10FF}").collect::<String>();
let long_log = format!("{long_padding}ERROR: fifth log");
debug_log.enqueue_read_entry(&TestDebugEntry::new(long_log.as_bytes()));
let log_bridge = DebugLogBridge::create(debug_log, Default::default());
let mut log_stream =
Box::pin(log_bridge.listen()).map(|r| r.unwrap().parse(&KERNEL_IDENTITY));
let log_message = log_stream.try_next().await.unwrap().unwrap();
assert_eq!(log_message.msg().unwrap(), "ERROR: first log");
assert_eq!(log_message.metadata.severity, Severity::Error);
let log_message = log_stream.try_next().await.unwrap().unwrap();
assert_eq!(log_message.msg().unwrap(), "first log error");
assert_eq!(log_message.metadata.severity, Severity::Info);
let log_message = log_stream.try_next().await.unwrap().unwrap();
assert_eq!(log_message.msg().unwrap(), "WARNING: second log");
assert_eq!(log_message.metadata.severity, Severity::Warn);
let log_message = log_stream.try_next().await.unwrap().unwrap();
assert_eq!(log_message.msg().unwrap(), "INFO: third log");
assert_eq!(log_message.metadata.severity, Severity::Info);
let log_message = log_stream.try_next().await.unwrap().unwrap();
assert_eq!(log_message.msg().unwrap(), "fourth log");
assert_eq!(log_message.metadata.severity, Severity::Info);
let log_message = log_stream.try_next().await.unwrap().unwrap();
assert_eq!(
log_message.msg().unwrap(),
"ERROR: severity takes precedence over msg when not info"
);
assert_eq!(log_message.metadata.severity, Severity::Warn);
}
}