implements PLN-0096

This commit is contained in:
bQUARKz 2026-06-05 09:56:14 +01:00
parent 8c43d85ce8
commit e4c1390614
Signed by: bquarkz
SSH Key Fingerprint: SHA256:Z7dgqoglWwoK6j6u4QC87OveEq74WOhFN+gitsxtkf8
4 changed files with 181 additions and 22 deletions

View File

@ -4,6 +4,7 @@ use prometeu_hal::{
FrameId, Game2DFramePacket, RenderOwnership, RenderSubmission, RenderSubmissionPacket,
ShellUiFramePacket,
};
use std::panic::{AssertUnwindSafe, catch_unwind};
use std::sync::atomic::Ordering;
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
@ -17,6 +18,27 @@ pub enum RenderSubmissionError {
PacketAppModeMismatch { active: AppMode },
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RenderConsumerState {
Running,
Stopped,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum RenderConsumeOutcome {
NoSubmission,
Presented { frame_id: FrameId },
DiscardedStaleEpoch { frame_id: FrameId },
DiscardedShutdown { frame_id: FrameId },
PresentFailed { frame_id: FrameId, message: String },
}
impl RenderConsumeOutcome {
pub fn presented(&self) -> bool {
matches!(self, Self::Presented { .. })
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RenderPacingPolicy {
FrameScheduled,
@ -92,8 +114,8 @@ impl LocalRenderWorker {
&mut self,
manager: &mut RenderManager,
surface: &mut S,
) -> bool {
manager.publish_latest(surface)
) -> RenderConsumeOutcome {
manager.consume_latest(surface)
}
}
@ -237,6 +259,7 @@ pub struct RenderManager {
handoff: RenderHandoff,
telemetry: RenderTelemetry,
transition_state: RenderTransitionState,
consumer_state: RenderConsumerState,
}
impl RenderManager {
@ -250,6 +273,7 @@ impl RenderManager {
handoff: RenderHandoff::default(),
telemetry: RenderTelemetry::default(),
transition_state: RenderTransitionState::Idle,
consumer_state: RenderConsumerState::Running,
}
}
@ -273,6 +297,10 @@ impl RenderManager {
self.transition_state
}
pub fn consumer_state(&self) -> RenderConsumerState {
self.consumer_state
}
pub fn latest_complete_submission(&self) -> Option<&RenderSubmission> {
self.handoff.latest_submission()
}
@ -301,6 +329,15 @@ impl RenderManager {
discarded
}
pub fn request_shutdown(&mut self) -> Option<RenderSubmission> {
self.consumer_state = RenderConsumerState::Stopped;
self.discard_pending_submission()
}
pub fn resume_consumer(&mut self) {
self.consumer_state = RenderConsumerState::Running;
}
pub fn render_telemetry(&self) -> RenderTelemetrySnapshot {
let mut snapshot = self.telemetry.snapshot;
snapshot.active_render_epoch = self.active_ownership.epoch;
@ -342,6 +379,16 @@ impl RenderManager {
self.telemetry.record_present_error(frame_id);
}
fn panic_payload_to_string(payload: Box<dyn std::any::Any + Send>) -> String {
if let Some(message) = payload.downcast_ref::<String>() {
return message.clone();
}
if let Some(message) = payload.downcast_ref::<&str>() {
return (*message).to_string();
}
"render panic without string payload".to_string()
}
pub fn set_active_app_mode(&mut self, app_mode: AppMode) {
self.transition_render_owner(app_mode, self.active_app_id);
}
@ -400,20 +447,43 @@ impl RenderManager {
self.close_frame_with_packet(packet).expect("compat packet matches active app mode")
}
pub fn publish_latest<S: RenderSurface>(&mut self, surface: &mut S) -> bool {
pub fn consume_latest<S: RenderSurface>(&mut self, surface: &mut S) -> RenderConsumeOutcome {
if self.consumer_state == RenderConsumerState::Stopped {
if let Some(discarded) = self.discard_pending_submission() {
return RenderConsumeOutcome::DiscardedShutdown { frame_id: discarded.frame_id };
}
return RenderConsumeOutcome::NoSubmission;
}
let Some(submission) = self.handoff.take_latest() else {
return false;
return RenderConsumeOutcome::NoSubmission;
};
if submission.ownership != self.active_ownership {
self.telemetry.record_stale_epoch_discard(submission.frame_id);
let frame_id = submission.frame_id;
self.handoff.record_stale_epoch_discard(submission);
return false;
return RenderConsumeOutcome::DiscardedStaleEpoch { frame_id };
}
self.telemetry.record_consumed(submission.frame_id);
surface.consume_submission(&submission);
let present_result =
catch_unwind(AssertUnwindSafe(|| surface.consume_submission(&submission)));
if let Err(payload) = present_result {
let frame_id = submission.frame_id;
self.telemetry.record_present_error(frame_id);
self.handoff.record_consumed(submission);
return RenderConsumeOutcome::PresentFailed {
frame_id,
message: Self::panic_payload_to_string(payload),
};
}
self.telemetry.record_presented(submission.frame_id);
let frame_id = submission.frame_id;
self.handoff.record_consumed(submission);
true
RenderConsumeOutcome::Presented { frame_id }
}
pub fn publish_latest<S: RenderSurface>(&mut self, surface: &mut S) -> bool {
self.consume_latest(surface).presented()
}
}
@ -440,6 +510,15 @@ mod tests {
}
}
#[derive(Default)]
struct PanickingSurface;
impl RenderSurface for PanickingSurface {
fn consume_submission(&mut self, _submission: &RenderSubmission) {
panic!("present backend failed");
}
}
#[test]
fn frame_closure_assigns_monotonic_frame_ids() {
let mut manager = RenderManager::new(AppMode::Game);
@ -589,13 +668,78 @@ mod tests {
let mut worker = LocalRenderWorker;
manager.close_compat_frame();
assert!(worker.consume_latest(&mut manager, &mut surface));
assert!(worker.consume_latest(&mut manager, &mut surface).presented());
assert_eq!(surface.seen, vec![FrameId::ZERO]);
assert_eq!(manager.render_telemetry().consumed_submissions, 1);
assert_eq!(manager.render_telemetry().presented_frames, 1);
}
#[test]
fn request_shutdown_discards_pending_submission_without_presenting() {
let mut manager = RenderManager::new(AppMode::Game);
manager.close_compat_frame();
let discarded = manager.request_shutdown().expect("pending submission discarded");
assert_eq!(discarded.frame_id, FrameId::ZERO);
assert_eq!(manager.consumer_state(), RenderConsumerState::Stopped);
assert!(manager.pending_submission().is_none());
assert_eq!(manager.discarded_pending(), 1);
assert_eq!(manager.render_telemetry().shutdown_discards, 1);
assert_eq!(manager.render_telemetry().last_dropped_frame_id, 0);
}
#[test]
fn stopped_consumer_discards_new_pending_submission_before_present() {
let mut manager = RenderManager::new(AppMode::Game);
let mut surface = RecordingSurface::default();
manager.request_shutdown();
manager.close_compat_frame();
let outcome = manager.consume_latest(&mut surface);
assert_eq!(outcome, RenderConsumeOutcome::DiscardedShutdown { frame_id: FrameId::ZERO });
assert!(surface.seen.is_empty());
assert_eq!(manager.render_telemetry().shutdown_discards, 1);
assert_eq!(manager.render_telemetry().presented_frames, 0);
}
#[test]
fn resume_consumer_allows_presentation_after_shutdown() {
let mut manager = RenderManager::new(AppMode::Game);
let mut surface = RecordingSurface::default();
manager.request_shutdown();
manager.resume_consumer();
manager.close_compat_frame();
assert!(manager.consume_latest(&mut surface).presented());
assert_eq!(surface.seen, vec![FrameId::ZERO]);
}
#[test]
fn present_panic_is_reported_without_unwinding_to_vm() {
let mut manager = RenderManager::new(AppMode::Game);
let mut surface = PanickingSurface;
manager.close_compat_frame();
let outcome = manager.consume_latest(&mut surface);
assert_eq!(
outcome,
RenderConsumeOutcome::PresentFailed {
frame_id: FrameId::ZERO,
message: "present backend failed".to_string()
}
);
assert_eq!(manager.render_telemetry().consumed_submissions, 1);
assert_eq!(manager.render_telemetry().present_errors, 1);
assert_eq!(manager.render_telemetry().presented_frames, 0);
assert_eq!(manager.render_telemetry().last_error_frame_id, 0);
}
#[test]
fn render_handoff_takes_owned_latest_submission() {
let mut handoff = RenderHandoff::default();

View File

@ -1,5 +1,7 @@
use super::dispatch::VmRuntimeHost;
use super::render_manager::{LocalRenderWorker, RenderConsumerPath, RenderSurface};
use super::render_manager::{
LocalRenderWorker, RenderConsumeOutcome, RenderConsumerPath, RenderSurface,
};
use super::*;
use crate::CrashReport;
use crate::fs::{FsState, VirtualFS};
@ -7,7 +9,7 @@ use crate::services::memcard::MemcardService;
use prometeu_hal::asset::{BankTelemetry, BankType};
use prometeu_hal::log::{LogLevel, LogService, LogSource};
use prometeu_hal::{
HardwareBridge, HostContext, InputSignals, RenderSubmission, RenderSubmissionPacket,
FrameId, HardwareBridge, HostContext, InputSignals, RenderSubmission, RenderSubmissionPacket,
ShellUiFramePacket,
};
use prometeu_vm::LogicalFrameEndingReason;
@ -259,7 +261,7 @@ impl VirtualMachineRuntime {
.expect("shell packet must match Shell app mode");
}
if let Err(payload) = catch_unwind(AssertUnwindSafe(|| {
let render_outcome = catch_unwind(AssertUnwindSafe(|| {
let mut surface = HardwareRenderSurface { hw };
match self
.render_manager
@ -267,25 +269,38 @@ impl VirtualMachineRuntime {
.resolve_consumer_path(self.render_capabilities)
{
RenderConsumerPath::LocalSynchronous => {
self.render_manager.publish_latest(&mut surface);
self.render_manager.consume_latest(&mut surface)
}
RenderConsumerPath::LocalWorkerPrototype => {
let mut worker = LocalRenderWorker;
worker.consume_latest(&mut self.render_manager, &mut surface);
worker.consume_latest(&mut self.render_manager, &mut surface)
}
}
})) {
let message = Self::host_panic_payload_to_string(payload);
let report = CrashReport::VmPanic { message, pc: Some(vm.pc() as u32) };
}));
let render_outcome = match render_outcome {
Ok(outcome) => outcome,
Err(payload) => {
let message = Self::host_panic_payload_to_string(payload);
let frame_id = self
.render_manager
.pending_submission()
.map(|submission| submission.frame_id)
.unwrap_or(FrameId::ZERO);
self.render_manager.record_render_error(frame_id);
RenderConsumeOutcome::PresentFailed { frame_id, message }
}
};
if let RenderConsumeOutcome::PresentFailed { message, .. } = &render_outcome
{
self.log(
log_service,
LogLevel::Error,
LogSource::Vm,
report.log_tag(),
report.summary(),
0,
format!("Render publication failed: {}", message),
);
self.last_crash_report = Some(report.clone());
return Some(report);
}
// 1. Snapshot full telemetry at logical frame end

View File

@ -1,6 +1,6 @@
{"type":"meta","next_id":{"DSC":42,"AGD":42,"DEC":32,"PLN":98,"LSN":48,"CLSN":1}}
{"type":"discussion","id":"DSC-0039","status":"abandoned","ticket":"render-pipeline-family-and-future-3d","title":"Render Pipeline Family and Future 3D","created_at":"2026-06-04","updated_at":"2026-06-04","tags":["gfx","renderer","runtime","architecture","pipeline"],"agendas":[{"id":"AGD-0039","file":"AGD-0039-render-pipeline-family-and-future-3d.md","status":"abandoned","created_at":"2026-06-04","updated_at":"2026-06-04","_override_reason":"User explicitly chose to close this agenda without a new decision because DSC-0038 already established enough architecture for future extension, and 3D is intentionally deferred."}],"decisions":[],"plans":[],"lessons":[],"_override_reason":"User explicitly chose to close this agenda without a new decision because DSC-0038 already established enough architecture for future extension, and 3D is intentionally deferred."}
{"type":"discussion","id":"DSC-0040","status":"in_progress","ticket":"vm-render-parallel-execution-boundary","title":"VM and Render Parallel Execution Boundary","created_at":"2026-06-04","updated_at":"2026-06-05","tags":["runtime","renderer","vm","concurrency","architecture","perf"],"agendas":[{"id":"AGD-0040","file":"AGD-0040-vm-and-render-parallel-execution-boundary.md","status":"accepted","created_at":"2026-06-04","updated_at":"2026-06-05"}],"decisions":[{"id":"DEC-0031","file":"DEC-0031-vm-and-render-parallel-execution-boundary.md","status":"accepted","created_at":"2026-06-05","updated_at":"2026-06-05","ref_agenda":"AGD-0040"}],"plans":[{"id":"PLN-0087","file":"PLN-0087-fix-game2d-packet-overlay-composition.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0088","file":"PLN-0088-define-read-only-render-resource-boundary.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0089","file":"PLN-0089-introduce-render-handoff-abstraction.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0090","file":"PLN-0090-add-render-frame-pacing-contract.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0091","file":"PLN-0091-implement-appmode-render-policy-matrix.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0092","file":"PLN-0092-add-render-epoch-ownership-transitions.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0093","file":"PLN-0093-add-render-telemetry-counters-and-events.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0094","file":"PLN-0094-specify-async-render-boundary.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0095","file":"PLN-0095-prototype-local-render-worker-capability.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0096","file":"PLN-0096-define-render-shutdown-and-failure-handling.md","status":"open","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0097","file":"PLN-0097-add-async-render-integration-test-matrix.md","status":"open","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]}],"lessons":[]}
{"type":"discussion","id":"DSC-0040","status":"in_progress","ticket":"vm-render-parallel-execution-boundary","title":"VM and Render Parallel Execution Boundary","created_at":"2026-06-04","updated_at":"2026-06-05","tags":["runtime","renderer","vm","concurrency","architecture","perf"],"agendas":[{"id":"AGD-0040","file":"AGD-0040-vm-and-render-parallel-execution-boundary.md","status":"accepted","created_at":"2026-06-04","updated_at":"2026-06-05"}],"decisions":[{"id":"DEC-0031","file":"DEC-0031-vm-and-render-parallel-execution-boundary.md","status":"accepted","created_at":"2026-06-05","updated_at":"2026-06-05","ref_agenda":"AGD-0040"}],"plans":[{"id":"PLN-0087","file":"PLN-0087-fix-game2d-packet-overlay-composition.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0088","file":"PLN-0088-define-read-only-render-resource-boundary.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0089","file":"PLN-0089-introduce-render-handoff-abstraction.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0090","file":"PLN-0090-add-render-frame-pacing-contract.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0091","file":"PLN-0091-implement-appmode-render-policy-matrix.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0092","file":"PLN-0092-add-render-epoch-ownership-transitions.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0093","file":"PLN-0093-add-render-telemetry-counters-and-events.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0094","file":"PLN-0094-specify-async-render-boundary.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0095","file":"PLN-0095-prototype-local-render-worker-capability.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0096","file":"PLN-0096-define-render-shutdown-and-failure-handling.md","status":"done","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]},{"id":"PLN-0097","file":"PLN-0097-add-async-render-integration-test-matrix.md","status":"open","created_at":"2026-06-05","updated_at":"2026-06-05","ref_decisions":["DEC-0031"]}],"lessons":[]}
{"type":"discussion","id":"DSC-0041","status":"open","ticket":"foreground-stack-game-pause-shell-vm-backed","title":"Foreground Stack, Game Pause, and VM-Backed Shell Coexistence","created_at":"2026-06-05","updated_at":"2026-06-05","tags":["runtime","os","lifecycle","shell","game","vm","foreground","architecture"],"agendas":[{"id":"AGD-0041","file":"AGD-0041-foreground-stack-game-pause-shell-vm-backed.md","status":"open","created_at":"2026-06-05","updated_at":"2026-06-05"}],"decisions":[],"plans":[],"lessons":[]}
{"type":"discussion","id":"DSC-0038","status":"done","ticket":"render-frame-packet-boundary","title":"Logical Render Pipelines and Command Packets","created_at":"2026-05-25","updated_at":"2026-06-04","tags":["gfx","renderer","runtime","frame-composer","architecture","ui","pipeline"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0047","file":"discussion/lessons/DSC-0038-render-frame-packet-boundary/LSN-0047-typed-render-submissions-preserve-domain-boundaries.md","status":"done","created_at":"2026-06-04","updated_at":"2026-06-04"}]}
{"type":"discussion","id":"DSC-0035","status":"done","ticket":"task-owned-shell-windows","title":"Agenda - Task-Owned Shell Windows","created_at":"2026-05-15","updated_at":"2026-05-15","tags":["runtime","os","task","window-manager","shell","lifecycle"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0044","file":"discussion/lessons/DSC-0035-task-owned-shell-windows/LSN-0044-task-window-liveness-belongs-to-the-task.md","status":"done","created_at":"2026-05-15","updated_at":"2026-05-15"}]}

View File

@ -2,7 +2,7 @@
id: PLN-0096
ticket: vm-render-parallel-execution-boundary
title: Define Render Shutdown and Failure Handling
status: open
status: done
created: 2026-06-05
ref_decisions: [DEC-0031]
tags: [runtime, renderer, shutdown, errors]