implements PLN-0090
This commit is contained in:
@@ -0,0 +1,97 @@
|
||||
use prometeu_hal::FrameId;
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub enum FrameAuthorizationError {
|
||||
GameFrameAlreadyActive { active_frame_id: FrameId },
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Default)]
|
||||
pub struct FrameScheduler {
|
||||
next_game_frame_id: FrameId,
|
||||
active_game_frame_id: Option<FrameId>,
|
||||
completed_game_frames: u64,
|
||||
logical_frame_overruns: u64,
|
||||
}
|
||||
|
||||
impl FrameScheduler {
|
||||
pub fn authorize_game_frame(&mut self) -> Result<FrameId, FrameAuthorizationError> {
|
||||
if let Some(active_frame_id) = self.active_game_frame_id {
|
||||
return Err(FrameAuthorizationError::GameFrameAlreadyActive { active_frame_id });
|
||||
}
|
||||
|
||||
let frame_id = self.next_game_frame_id;
|
||||
self.next_game_frame_id = self.next_game_frame_id.next();
|
||||
self.active_game_frame_id = Some(frame_id);
|
||||
Ok(frame_id)
|
||||
}
|
||||
|
||||
pub fn complete_game_frame(&mut self) -> Option<FrameId> {
|
||||
let completed = self.active_game_frame_id.take();
|
||||
if completed.is_some() {
|
||||
self.completed_game_frames = self.completed_game_frames.wrapping_add(1);
|
||||
}
|
||||
completed
|
||||
}
|
||||
|
||||
pub fn record_logical_frame_overrun(&mut self) {
|
||||
self.logical_frame_overruns = self.logical_frame_overruns.wrapping_add(1);
|
||||
}
|
||||
|
||||
pub fn active_game_frame_id(&self) -> Option<FrameId> {
|
||||
self.active_game_frame_id
|
||||
}
|
||||
|
||||
pub fn completed_game_frames(&self) -> u64 {
|
||||
self.completed_game_frames
|
||||
}
|
||||
|
||||
pub fn logical_frame_overruns(&self) -> u64 {
|
||||
self.logical_frame_overruns
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn authorizes_one_game_frame_until_completion() {
|
||||
let mut scheduler = FrameScheduler::default();
|
||||
|
||||
assert_eq!(scheduler.authorize_game_frame(), Ok(FrameId::ZERO));
|
||||
assert_eq!(
|
||||
scheduler.authorize_game_frame(),
|
||||
Err(FrameAuthorizationError::GameFrameAlreadyActive { active_frame_id: FrameId::ZERO })
|
||||
);
|
||||
|
||||
assert_eq!(scheduler.complete_game_frame(), Some(FrameId::ZERO));
|
||||
assert_eq!(scheduler.authorize_game_frame(), Ok(FrameId::new(1)));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn completion_is_sequential_without_catch_up_frames() {
|
||||
let mut scheduler = FrameScheduler::default();
|
||||
|
||||
for expected in 0..3 {
|
||||
let frame_id = scheduler.authorize_game_frame().expect("frame authorization");
|
||||
assert_eq!(frame_id, FrameId::new(expected));
|
||||
assert_eq!(scheduler.complete_game_frame(), Some(FrameId::new(expected)));
|
||||
}
|
||||
|
||||
assert_eq!(scheduler.completed_game_frames(), 3);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn records_logical_frame_overrun_without_advancing_frame_id() {
|
||||
let mut scheduler = FrameScheduler::default();
|
||||
|
||||
assert_eq!(scheduler.authorize_game_frame(), Ok(FrameId::ZERO));
|
||||
scheduler.record_logical_frame_overrun();
|
||||
scheduler.record_logical_frame_overrun();
|
||||
|
||||
assert_eq!(scheduler.logical_frame_overruns(), 2);
|
||||
assert_eq!(scheduler.active_game_frame_id(), Some(FrameId::ZERO));
|
||||
assert_eq!(scheduler.complete_game_frame(), Some(FrameId::ZERO));
|
||||
assert_eq!(scheduler.authorize_game_frame(), Ok(FrameId::new(1)));
|
||||
}
|
||||
}
|
||||
@@ -22,6 +22,7 @@ impl VirtualMachineRuntime {
|
||||
current_cartridge_title: String::new(),
|
||||
current_cartridge_app_version: String::new(),
|
||||
current_cartridge_app_mode: AppMode::Game,
|
||||
frame_scheduler: FrameScheduler::default(),
|
||||
render_manager: RenderManager::new(AppMode::Game),
|
||||
gfx2d_commands: Vec::new(),
|
||||
gfxui_commands: Vec::new(),
|
||||
@@ -119,6 +120,7 @@ impl VirtualMachineRuntime {
|
||||
self.current_cartridge_title.clear();
|
||||
self.current_cartridge_app_version.clear();
|
||||
self.current_cartridge_app_mode = AppMode::Game;
|
||||
self.frame_scheduler = FrameScheduler::default();
|
||||
self.render_manager = RenderManager::new(AppMode::Game);
|
||||
self.gfx2d_commands.clear();
|
||||
self.gfxui_commands.clear();
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
mod dispatch;
|
||||
mod frame_scheduler;
|
||||
mod lifecycle;
|
||||
pub mod render_manager;
|
||||
#[cfg(test)]
|
||||
@@ -6,6 +7,7 @@ mod tests;
|
||||
mod tick;
|
||||
|
||||
use crate::CrashReport;
|
||||
pub use frame_scheduler::FrameScheduler;
|
||||
use prometeu_bytecode::string_materialization_count;
|
||||
use prometeu_hal::app_mode::AppMode;
|
||||
use prometeu_hal::log::LogService;
|
||||
@@ -28,6 +30,7 @@ pub struct VirtualMachineRuntime {
|
||||
pub current_cartridge_title: String,
|
||||
pub current_cartridge_app_version: String,
|
||||
pub current_cartridge_app_mode: AppMode,
|
||||
pub frame_scheduler: FrameScheduler,
|
||||
pub render_manager: RenderManager,
|
||||
pub gfx2d_commands: Vec<Gfx2dCommand>,
|
||||
pub gfxui_commands: Vec<GfxUiCommand>,
|
||||
|
||||
@@ -141,6 +141,11 @@ impl VirtualMachineRuntime {
|
||||
self.update_fs(log_service, fs, fs_state);
|
||||
|
||||
if !self.logical_frame_active {
|
||||
if self.current_cartridge_app_mode == AppMode::Game {
|
||||
self.frame_scheduler
|
||||
.authorize_game_frame()
|
||||
.expect("logical frame cannot start while another Game frame is active");
|
||||
}
|
||||
self.logical_frame_active = true;
|
||||
self.logical_frame_remaining_cycles = Self::CYCLES_PER_LOGICAL_FRAME;
|
||||
self.begin_logical_frame(signals, hw);
|
||||
@@ -317,6 +322,9 @@ impl VirtualMachineRuntime {
|
||||
self.logical_frame_index += 1;
|
||||
self.logical_frame_active = false;
|
||||
self.logical_frame_remaining_cycles = 0;
|
||||
if self.current_cartridge_app_mode == AppMode::Game {
|
||||
self.frame_scheduler.complete_game_frame();
|
||||
}
|
||||
|
||||
if run.reason == LogicalFrameEndingReason::FrameSync {
|
||||
self.needs_prepare_entry_call = true;
|
||||
@@ -326,6 +334,10 @@ impl VirtualMachineRuntime {
|
||||
self.paused = true;
|
||||
self.debug_step_request = false;
|
||||
}
|
||||
} else if run.reason == LogicalFrameEndingReason::BudgetExhausted
|
||||
&& self.current_cartridge_app_mode == AppMode::Game
|
||||
{
|
||||
self.frame_scheduler.record_logical_frame_overrun();
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
|
||||
Reference in New Issue
Block a user