feat(diagnostics): preserve Registry and resource fault context for PLN-0176 step 28
This commit is contained in:
@@ -1,6 +1,7 @@
|
||||
use prometeu_bytecode::TrapInfo;
|
||||
use prometeu_vm::VmInitError;
|
||||
use std::fmt;
|
||||
mod init_diagnostic;
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub enum CrashReport {
|
||||
@@ -10,6 +11,20 @@ pub enum CrashReport {
|
||||
}
|
||||
|
||||
impl CrashReport {
|
||||
/// The same machine fields serve headless and desktop transports.
|
||||
pub fn init_diagnostic(&self) -> Option<serde_json::Value> {
|
||||
match self {
|
||||
Self::VmInit { error } => Some(init_diagnostic::serialize(error)),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
pub fn resource_failure(&self) -> Option<prometeu_bytecode::ResourceFailure> {
|
||||
match self {
|
||||
Self::VmTrap { trap } => trap.resource,
|
||||
Self::VmInit { error: VmInitError::RuntimeResourceLimit(resource) } => Some(*resource),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
pub fn kind(&self) -> &'static str {
|
||||
match self {
|
||||
Self::VmTrap { .. } => "vm_trap",
|
||||
|
||||
@@ -0,0 +1,132 @@
|
||||
use prometeu_vm::VmInitError;
|
||||
use serde_json::{Value, json};
|
||||
|
||||
pub(super) fn serialize(error: &VmInitError) -> Value {
|
||||
let code = match error {
|
||||
VmInitError::RegistryLoadFailed(_) => "registry_load_failed",
|
||||
VmInitError::RuntimeResourceLimit(_) => "runtime_resource_limit",
|
||||
VmInitError::InvalidFormat => "invalid_format",
|
||||
VmInitError::UnsupportedFormat => "unsupported_format",
|
||||
VmInitError::ImageLoadFailed(_) => "image_load_failed",
|
||||
VmInitError::LoaderPatchFailed(_) => "loader_patch_failed",
|
||||
VmInitError::EntrypointNotFound => "entrypoint_not_found",
|
||||
VmInitError::EntrypointArgumentsInvalid { .. } => "entrypoint_arguments_invalid",
|
||||
VmInitError::VerificationFailed(_) => "verification_failed",
|
||||
};
|
||||
let mut result = json!({"code":code,"message":format!("{error:?}")});
|
||||
match error {
|
||||
VmInitError::RegistryLoadFailed(load) => {
|
||||
result["load"] = json!(load);
|
||||
result["load"]["code"] = json!(load.code.tag());
|
||||
}
|
||||
VmInitError::RuntimeResourceLimit(resource) => result["resource"] = json!(resource),
|
||||
VmInitError::EntrypointArgumentsInvalid { function, slot, trap_code } => {
|
||||
result["entry"] = json!({"function":function,"slot":slot,"trapCode":trap_code});
|
||||
}
|
||||
VmInitError::LoaderPatchFailed(patch) => {
|
||||
use prometeu_vm::LoaderPatchError as P;
|
||||
result["binding"] = match patch {
|
||||
P::ResolveFailed(native) => json!(native),
|
||||
P::HostcallIndexOutOfBounds { pc, sysc_index, syscalls_len } => {
|
||||
json!({"reason":"hostcall_index_out_of_bounds","pc":pc,"syscallIndex":sysc_index,"syscallsLength":syscalls_len})
|
||||
}
|
||||
P::RawSyscallInPreloadArtifact { pc, syscall_id } => {
|
||||
json!({"reason":"raw_syscall","pc":pc,"syscallId":syscall_id})
|
||||
}
|
||||
P::UnusedSyscallDecl { sysc_index, module, name, version } => {
|
||||
json!({"reason":"unused_syscall","syscallIndex":sysc_index,"module":module,"name":name,"version":version})
|
||||
}
|
||||
P::HostcallRemaining { pc, sysc_index } => {
|
||||
json!({"reason":"hostcall_remaining","pc":pc,"syscallIndex":sysc_index})
|
||||
}
|
||||
P::DecodeFailed(_) => json!({"reason":"decode_failed"}),
|
||||
};
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
result
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::CrashReport;
|
||||
use prometeu_bytecode::{
|
||||
ResourceFailure, ResourceReason, RuntimeResource,
|
||||
load_limits::{IdDomain, LoadCode, LoadFailure, LoadReason},
|
||||
};
|
||||
#[test]
|
||||
fn load_tag_and_reference_context_survive_without_fabricating_runtime_pc() {
|
||||
let error = LoadFailure::new(LoadCode::InvalidReference, LoadReason::TypeId)
|
||||
.at(6, 159)
|
||||
.record(4)
|
||||
.member(2)
|
||||
.reference(IdDomain::Type, 77)
|
||||
.in_function(3, Some(18));
|
||||
let report = CrashReport::VmInit { error: VmInitError::RegistryLoadFailed(error) };
|
||||
assert_eq!(report.pc(), None);
|
||||
let wire = report.init_diagnostic().unwrap();
|
||||
assert_eq!(wire["code"], "registry_load_failed");
|
||||
assert_eq!(wire["load"]["code"], "LOAD_INVALID_REFERENCE");
|
||||
for (field, value) in [
|
||||
("section", 6),
|
||||
("offset", 159),
|
||||
("record", 4),
|
||||
("member", 2),
|
||||
("referenced_id", 77),
|
||||
("function", 3),
|
||||
("pc", 18),
|
||||
] {
|
||||
assert_eq!(wire["load"][field], value);
|
||||
}
|
||||
assert_eq!(wire["load"]["id_domain"], "Type");
|
||||
assert_eq!(wire["load"]["reason"], "TypeId");
|
||||
}
|
||||
#[test]
|
||||
fn native_abi_and_resource_context_are_machine_fields() {
|
||||
let native = prometeu_hal::syscalls::DeclaredLoadError::AbiMismatch {
|
||||
module: "system".into(),
|
||||
name: "has_cart".into(),
|
||||
version: 1,
|
||||
declared_arg_slots: 0,
|
||||
declared_ret_slots: 2,
|
||||
expected_arg_slots: 0,
|
||||
expected_ret_slots: 1,
|
||||
};
|
||||
let wire = serialize(&VmInitError::LoaderPatchFailed(
|
||||
prometeu_vm::LoaderPatchError::ResolveFailed(native),
|
||||
));
|
||||
assert_eq!(wire["binding"]["reason"], "abi_mismatch");
|
||||
assert_eq!(wire["binding"]["module"], "system");
|
||||
assert_eq!(wire["binding"]["declared_ret_slots"], 2);
|
||||
assert_eq!(wire["binding"]["expected_ret_slots"], 1);
|
||||
let resource = ResourceFailure {
|
||||
resource: RuntimeResource::CallDepth,
|
||||
reason: ResourceReason::Limit,
|
||||
requested: 3,
|
||||
limit: 2,
|
||||
};
|
||||
let report = CrashReport::VmInit { error: VmInitError::RuntimeResourceLimit(resource) };
|
||||
assert_eq!(report.resource_failure(), Some(resource));
|
||||
let wire = report.init_diagnostic().unwrap();
|
||||
assert_eq!(wire["resource"]["resource"], "CallDepth");
|
||||
assert_eq!(wire["resource"]["reason"], "Limit");
|
||||
assert_eq!(wire["resource"]["requested"], 3);
|
||||
assert_eq!(wire["resource"]["limit"], 2);
|
||||
}
|
||||
#[test]
|
||||
fn all_load_codes_serialize_to_the_normative_tags() {
|
||||
for code in [
|
||||
LoadCode::InvalidFormat,
|
||||
LoadCode::UnsupportedFormat,
|
||||
LoadCode::InvalidReference,
|
||||
LoadCode::InvalidRegistry,
|
||||
LoadCode::InvalidCode,
|
||||
LoadCode::ResourceLimit,
|
||||
LoadCode::InvalidEntrypoint,
|
||||
] {
|
||||
assert_eq!(json!(code), code.tag());
|
||||
assert_eq!(serde_json::from_value::<LoadCode>(json!(code)).unwrap(), code);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user