[PERF] Host Debug Overlay Isolation

This commit is contained in:
2026-04-10 10:55:15 +01:00
parent f5580ae0ce
commit 47ab664280
21 changed files with 526 additions and 154 deletions
@@ -2,72 +2,48 @@
id: AGD-0012
ticket: perf-host-debug-overlay-isolation
title: Agenda - [PERF] Host Debug Overlay Isolation
status: open
status: done
created: 2026-03-27
resolved:
decision:
tags: []
resolved: 2026-04-10
decision: DEC-0007
tags: [performance, host, gfx]
---
# Agenda - [PERF] Host Debug Overlay Isolation
## Contexto
O overlay de debug é uma ferramenta exclusiva para o ambiente **Desktop** (`prometeu-host-desktop-winit`). Ele visa fornecer telemetria em tempo real para desenvolvedores sem impactar a fidelidade da emulação ou o desempenho medido do hardware final (handhelds/consoles de baixo custo), onde este overlay não existirá.
## Problema
Atualmente, o overlay de debug está indevidamente acoplado ao pipeline de `gfx` emulado e ao processamento do runtime.
- **Distorção de Performance:** O custo de renderizar o HUD técnico (formatação de strings e draw calls extras) é contabilizado como custo do jogo.
- **Acoplamento de Pipeline:** O pipeline de `gfx` precisa processar elementos que não pertencem à lógica da máquina virtual.
- **Hotspots:** `runner.rs` realiza `present()` extra e manipulação de texto no loop principal.
O overlay de debug ainda usa o pipeline emulado de `gfx` e injeta custo visual no caminho normal do host.
## Pontos Críticos
- **Fato:** O overlay é uma necessidade de desenvolvimento Desktop, não uma funcionalidade da máquina `prometeu`.
- **Risco:** Qualquer processamento de overlay dentro do runtime `prometeu` invalida a pureza dos ciclos medidos para certificação.
- **Tradeoff:** Mover o overlay para o Host exige acesso assíncrono ou passivo aos dados de telemetria.
- **Hipótese:** Um overlay 100% nativo no Host (Winit/Pixels) usando fontes TrueType terá custo desprezível e legibilidade superior.
Hoje o host formata strings por frame, desenha texto via `gfx` e faz `present()` extra para sobrepor telemetria.
## Opções
- **Opção A (Recomendada):** Camada Host Nativa. O `HostRunner` renderiza o HUD em uma surface separada ou faz um *compositing* nativo após o upscaling do framebuffer do console.
- **Opção B:** Overlay via IPC/Sidecar. Ferramenta externa de inspeção (descartada por complexidade visual).
- **Opção C:** Manter no `gfx` emulado com otimização (descartada por não resolver o acoplamento).
## Dor
## Sugestão / Recomendação
1. **Agnosticismo de GFX:** O overlay deve ser tratado como uma "película" transparente aplicada pelo Host Desktop sobre o resultado final da renderização.
2. **Isolamento de Processamento:** Nenhuma instrução de desenho ou formatação de strings do overlay deve ocorrer dentro do runtime.
3. **Acesso via API:** O Host acessará os dados de telemetria através de uma API dedicada (baseada no modelo push-based da `DEC-0005`).
4. **Interface de Controle:** O acionamento permanece via tecla **F1** como um *toggle*, gerenciado pela camada de Host.
5. **Composição via Host:** Utilizar bibliotecas nativas do Host para renderizar o HUD com fontes TrueType nítidas e Alpha Blending real.
- debug ligado altera custo do render path que deveria estar sendo medido.
- overlay de desenvolvimento distorce a leitura de performance do console.
- handheld barato nao deveria pagar composicao de HUD tecnico no mesmo pipeline do jogo.
## Perguntas em Aberto
- Nenhuma. As questões sobre acesso via API e acionamento via F1 foram resolvidas durante a discussão.
## Hotspots Atuais
- [runner.rs](/Users/niltonconstantino/personal/workspace.personal/intrepid/prometeu/runtime/crates/host/prometeu-host-desktop-winit/src/runner.rs#L126)
- [runner.rs](/Users/niltonconstantino/personal/workspace.personal/intrepid/prometeu/runtime/crates/host/prometeu-host-desktop-winit/src/runner.rs#L381)
## Alvo da Discussao
Isolar o overlay de debug do custo medido do console sem perder utilidade para desenvolvimento.
## O Que Precisa Ser Definido
1. Lugar de composicao.
Decidir se o overlay:
- continua no `gfx` emulado;
- sobe para camada host nativa;
- vira surface separada de debug.
2. Politica de strings/glyphs.
Definir se texto e reconstruido por frame ou cacheado.
3. Custo em modo debug.
Delimitar qual overhead e aceitavel quando overlay estiver ativo.
4. Efeito na telemetria.
Fechar se a telemetria deve incluir ou excluir explicitamente o custo do overlay.
## Open Questions de Arquitetura
1. O overlay precisa ser representativo do hardware final ou apenas ferramenta de desktop?
Não, como é HUD técnico, pode e deve ser renderizado pelo Host nativo para melhor legibilidade.
2. Vale um modo "perf puro" onde overlay nunca toca no framebuffer do console?
Sim. O isolamento garante que o `gfx` emulado esteja 100% livre para o jogo durante a medição.
3. O host deve oferecer toggles separados para stats, logs e overlay visual?
Sim. O `HostRunner` deve expor controles granulares via `inspection_active`.
4. Como melhorar a legibilidade e estética (Glyphs/Transparência)?
Migrar a renderização do HUD para o Host Nativo (Winit/Pixels), permitindo o uso de fontes TrueType (monospaced) nítidas e Alpha Blending real para transparência no fundo do painel.
## Dependencias
- `../specs/10-debug-inspection-and-profiling.md`
- `../specs/11-portability-and-cross-platform-execution.md`
## Sugestao / Recomendacao
1. **Migração para Camada Host Nativa:** Renderizar o HUD de debug em uma surface separada ou via pipeline nativo do Host (depois do upscaling do framebuffer do console).
2. **Fontes TrueType (Mono):** Substituir os glyphs bitmapped rudimentares por uma fonte nativa de alta qualidade e nítida.
3. **Composição Alpha:** Permitir fundo semi-transparente para o overlay para não bloquear a visão do jogo.
4. **Acionamento Explícito:** Host deve gerenciar `inspection_active: true` no runtime apenas quando o HUD ou Debugger estiverem ativos.
## Critério para Encerrar
A agenda é considerada encerrada quando:
- Houver consenso sobre o isolamento total do pipeline de `gfx`.
- O método de acesso aos dados (API) estiver definido.
- O controle de interface (F1) estiver estabelecido.
*(Critérios atingidos em 2026-04-10)*
@@ -0,0 +1,31 @@
# AGD-0021: Full Migration to Atomic Telemetry
## Contexto
Durante a implementação do isolamento do overlay de debug no Host Desktop (DEC-0007), foi introduzido o `AtomicTelemetry` para permitir acesso assíncrono e sem locks aos dados de performance. Por motivos de cautela inicial, os campos legados `telemetry_current` e `telemetry_last` foram mantidos no `VirtualMachineRuntime` para compatibilidade com processos de certificação e logs internos.
## Problema
A manutenção de dois sistemas paralelos de telemetria gera redundância de código, aumenta a superfície de erro e consome ciclos de CPU desnecessários para atualizar dados que já estão disponíveis de forma mais eficiente via atômicos. A "compatibilidade" pretendida não justifica o débito técnico de manter estruturas duplicadas.
## Pontos Críticos
- **Fato:** `AtomicTelemetry` já provê todos os dados necessários (ciclos, memória, logs).
- **Risco:** Remoção de `telemetry_last` pode quebrar ferramentas que dependem de snapshots estáticos por frame se não houver um substituto claro de snapshot via atômicos.
- **Tradeoff:** A migração exige refatorar o `VirtualMachineRuntime` e possivelmente o `LogService` para convergirem em uma única fonte de verdade.
- **Hipótese:** Um snapshot derivado do `AtomicTelemetry` ao final de cada frame é suficiente para substituir o `telemetry_last` legado sem perda de precisão.
## Opções
- **Opção A (Recomendada):** Migração total e remoção dos campos legados. O `AtomicTelemetry` torna-se a única fonte de verdade. Onde snapshots estáveis são necessários, eles são extraídos via `AtomicTelemetry::snapshot()`.
- **Opção B:** Manter redundância (Descartada pelo usuário).
## Sugestão / Recomendação
1. Remover `telemetry_current` e `telemetry_last` do `VirtualMachineRuntime`.
2. Refatorar o loop de execução para atualizar exclusivamente o `AtomicTelemetry`.
3. Garantir que o `LogService` e outras auditorias consumam dados do novo modelo.
4. Atualizar as especificações para refletir o modelo único.
## Perguntas em Aberto
1. Existe algum uso específico de `telemetry_last` em ferramentas externas (não mapeadas) que dependem do layout de memória antigo? (Assumimos que não para este escopo).
## Criterio para Encerrar
- Remoção completa dos campos no código.
- Compilação e execução bem-sucedida do Host Desktop com o novo modelo único.
- Atualização da documentação normativa.
@@ -0,0 +1,53 @@
---
id: DEC-0007
ticket: perf-host-debug-overlay-isolation
title: Decision - [PERF] Host Debug Overlay Isolation
status: accepted
created: 2026-04-10
updated: 2026-04-10
agenda: AGD-0012
tags: [performance, host, gfx]
---
# Decision - [PERF] Host Debug Overlay Isolation
## Status
**Accepted**
## Contexto
O overlay de debug do PROMETEU, utilizado para exibir telemetria, logs e métricas em tempo real, está atualmente acoplado ao pipeline de renderização emulado (`gfx`) e ao processamento do runtime. Isso resulta em:
1. **Distorção de Performance:** O custo de formatar strings e realizar chamadas de desenho para o HUD técnico é contabilizado como ciclos do jogo, invalidando medições de certificação.
2. **Acoplamento Indevido:** O pipeline `gfx` emulado processa elementos visuais (HUD) que não existem no hardware original.
3. **Complexidade no Host:** O Host precisa lidar com a injeção dessas informações no buffer de emulação.
## Decisao
Fica decidido que o overlay de debug será movido integralmente para a camada **Host Desktop** (`prometeu-host-desktop-winit`), operando de forma 100% isolada do runtime e do pipeline de `gfx` emulado.
1. **Isolamento de Pipeline:** O overlay técnico deve ser tratado como uma "película" (layer) transparente aplicada pelo Host sobre o resultado final da renderização (pós-upscaling).
2. **Isolamento de Processamento:** Nenhuma instrução de desenho ou formatação de strings relacionada ao overlay deve ocorrer dentro do runtime ou durante os ciclos emulados.
3. **Acesso via API:** O Host acessará os dados necessários para o overlay através de uma API de telemetria passiva (baseada em atômicos, conforme definido na `DEC-0005`).
4. **Acionamento via F1:** O controle de visibilidade (toggle) do overlay é de responsabilidade exclusiva do Host, acionado pela tecla **F1**.
## Rationale
- **Pureza de Medição:** Ao remover o processamento do overlay do runtime, garantimos que 100% dos ciclos medidos pertencem à lógica do cartucho e periféricos emulados.
- **Desempenho no Hardware Alvo:** Como o overlay é exclusivo de Desktop, dispositivos handheld/consoles de baixo custo não devem pagar o preço de implementação ou ramificações lógicas para lidar com HUD técnico.
- **Qualidade Visual:** Utilizar o Host para renderizar o HUD permite o uso de fontes TrueType nítidas e Alpha Blending real, melhorando drasticamente a legibilidade para o desenvolvedor sem afetar a fidelidade da emulação.
## Invariantes / Contrato
- **Zero Overhead no Runtime:** A presença ou ausência do overlay não deve alterar o contador de ciclos consumidos por frame no runtime.
- **Agnosticismo de GFX:** O framebuffer emulado deve conter apenas os pixels gerados pelo cartucho, sem HUD técnico "queimado" na imagem.
- **Composição Assíncrona/Passiva:** O Host não deve bloquear o runtime para coletar dados para o overlay; a leitura deve ser feita a partir de buffers de telemetria já expostos.
## Impactos
- **Host (Desktop Winit):** Exige a implementação de uma camada de renderização nativa (ex: `egui` ou composição direta via `pixels`/`winit`) que suporte transparência.
- **Runtime API:** Deve expor campos de telemetria (FPS, Memory Usage, Cycles) via API para consumo pelo Host.
- **Especificações:** Atualização dos capítulos de Portabilidade e Debug para refletir o isolamento.
## Referencias
- `AGD-0012`: [PERF] Host Debug Overlay Isolation (Agenda de Origem).
- `DEC-0005`: [PERF] Push-based Telemetry Model (Modelo de acesso aos dados).
## Propagacao Necessaria
1. Remover hotspots de desenho de texto no `runner.rs` do host.
2. Implementar o novo sistema de HUD no host usando bibliotecas nativas.
3. Atualizar a documentação técnica em `docs/specs/runtime/`.
@@ -0,0 +1,35 @@
# DEC-0008: Full Migration to Atomic Telemetry
## Status
Accepted
## Contexto
Após o sucesso inicial do `AtomicTelemetry` (DEC-0007), identificou-se que a coexistência com os campos legados `telemetry_current` e `telemetry_last` no `VirtualMachineRuntime` é contraproducente. O usuário solicitou a remoção completa da camada de compatibilidade para simplificar o motor e garantir que o modelo atômico seja a única fonte de verdade para performance e inspeção.
## Decisao
1. **Remoção Total:** Eliminar os campos `telemetry_current` e `telemetry_last` da struct `VirtualMachineRuntime`.
2. **Modelo Único:** O `AtomicTelemetry` passa a ser a única estrutura responsável por rastrear métricas de execução (ciclos, memória, logs).
3. **Snapshot On-Demand:** Qualquer necessidade de telemetria estática (ex: para logs de erro ou final de frame) deve ser atendida pelo método `AtomicTelemetry::snapshot()`, que gera um `TelemetryFrame` imutável a partir do estado atômico atual.
4. **Atualização Condicional:** A atualização dos campos atômicos dentro do loop de `tick` da VM permanece protegida por `inspection_active`, garantindo overhead zero em modo de produção.
## Rationale
- **Simplicidade:** Reduz o número de campos no `VirtualMachineRuntime`.
- **Performance:** Evita a cópia de dados entre `telemetry_current` e `telemetry_last` ao final de cada frame.
- **Consistência:** Garante que o Host e o Runtime vejam os mesmos dados através da mesma API.
## Invariantes / Contrato
- O `VirtualMachineRuntime` deve possuir uma instância de `Arc<AtomicTelemetry>`.
- O `AtomicTelemetry` deve ser thread-safe (já garantido pelo uso de `std::sync::atomic`).
## Impactos
- **Runtime:** Alteração na struct principal e no loop de tick.
- **HAL:** Possível ajuste no `LogService` se ele dependia diretamente dos campos legados.
- **Docs:** Necessidade de atualizar as especificações de Debug e Portabilidade.
## Referencias
- AGD-0021 (Migration Agenda)
- DEC-0007 (Overlay Isolation Decision)
## Propagacao Necessaria
- Refatoração de `VirtualMachineRuntime`.
- Atualização de `prometeu-host-desktop-winit` para garantir que continua funcionando (já migrado no PLN-0006, mas deve ser validado).
@@ -0,0 +1,64 @@
---
id: PLN-0006
ticket: perf-host-debug-overlay-isolation
title: PR/Plan - [PERF] Host Debug Overlay Isolation
status: open
created: 2026-04-10
updated: 2026-04-10
decisions: [DEC-0007]
tags: [performance, host, gfx]
---
# PR/Plan - [PERF] Host Debug Overlay Isolation
## Briefing
Implementação do isolamento total do overlay de debug no Host Desktop (`prometeu-host-desktop-winit`), removendo o acoplamento com o runtime e o pipeline de `gfx` emulado.
## Decisions de Origem
- `DEC-0007`: [PERF] Host Debug Overlay Isolation.
- `DEC-0005`: [PERF] Push-based Telemetry Model (base para extração de dados).
## Alvo
- `crates/host/prometeu-host-desktop-winit`: Implementação da camada nativa de HUD.
- `crates/runtime`: Exposição de campos de telemetria via API.
- `docs/specs/runtime`: Atualização das especificações de debug e portabilidade.
## Escopo
- **Spec Work:**
- Atualizar `docs/specs/runtime/10-debug-inspection-and-profiling.md` para remover menções ao HUD emulado.
- Atualizar `docs/specs/runtime/11-portability-and-cross-platform-execution.md` para reforçar a separação de responsabilidades (Host-side HUD).
- **Code Work:**
- Expansão da API de telemetria no runtime para incluir todos os dados necessários (Cycles, Memory, Logs).
- Remoção do código de desenho de texto legado no `runner.rs`.
- Integração de biblioteca nativa (ex: `egui` ou composição via `pixels`) para renderização do novo overlay no Host.
- Implementação do toggle via tecla **F1** no `HostRunner`.
## Fora de Escopo
- Implementação de overlay visual em outros hosts (mobile, handheld).
- Alterações na lógica de emulação central (loop de execução).
## Plano de Execucao
1. **Fase 1: Especificações (Spec)**
- Revisar e atualizar os arquivos de especificação (`10-debug` e `11-portability`).
2. **Fase 2: Runtime Telemetry API (Code)**
- Garantir que todos os campos de telemetria estejam expostos via atômicos/push-based conforme `DEC-0005`.
3. **Fase 3: Host HUD Implementation (Code)**
- Integrar o novo motor de HUD no `prometeu-host-desktop-winit`.
- Conectar os dados da API de telemetria à visualização do HUD.
4. **Fase 4: Cleanup (Code)**
- Remover hotspots de formatação de strings e draw calls do overlay antigo no Host.
## Criterios de Aceite
- O overlay de debug é ativado/desativado via tecla **F1**.
- O overlay utiliza fontes TrueType (monospaced) nítidas e fundo semi-transparente.
- O framebuffer emulado não contém pixels do HUD (composição nativa pós-upscaling).
- O custo de ciclos do runtime é idêntico com o overlay ligado ou desligado.
## Tests / Validacao
- **Verificação Visual:** Confirmar a qualidade das fontes e a transparência do novo HUD.
- **Benchmarking:** Comparar os ciclos consumidos por frame com e sem o HUD ativo para provar isolamento.
- **Teste de Regressão:** Garantir que o F1 toggle não afeta a estabilidade do loop de emulação.
## Riscos
- **Overhead no Host:** A renderização nativa (ex: `egui`) pode introduzir overhead no Host Desktop em máquinas muito fracas (geralmente aceitável em Desktop).
- **Sincronização de Telemetria:** Pequeno atraso visual entre o frame renderizado e os dados exibidos se a coleta for puramente assíncrona (aceitável para telemetria de debug).
@@ -0,0 +1,52 @@
# PLN-0007: Full Migration to Atomic Telemetry
## Briefing
Este plano detalha a remoção técnica dos campos legados de telemetria no `VirtualMachineRuntime` e a migração de todos os consumidores para o modelo de `AtomicTelemetry` introduzido na DEC-0007.
## Decisions de Origem
- DEC-0008 (Full Migration to Atomic Telemetry)
- DEC-0007 (Host Debug Overlay Isolation)
## Alvo
- `crates/console/prometeu-system`
- `crates/console/prometeu-hal`
- `crates/host/prometeu-host-desktop-winit`
## Escopo
- Remoção de `telemetry_current` e `telemetry_last` de `VirtualMachineRuntime`.
- Refatoração do `VirtualMachineRuntime::tick` para remover atualizações redundantes.
- Atualização do `VirtualMachineRuntime::lifecycle` para remover inicialização e reset dos campos legados.
- Refatoração do `LogService` para consumir logs via `AtomicTelemetry`.
- Atualização do `HostRunner` (Desktop) para remover qualquer referência residual aos campos legados.
- Atualização das especificações técnicas em `docs/specs/runtime/`.
## Fora de Escopo
- Mudanças no formato do `TelemetryFrame` (a menos que estritamente necessário para compatibilidade).
- Otimizações de performance não relacionadas à telemetria.
## Plano de Execucao
1. **Fase 1: HAL & Telemetry**
- Verificar se `AtomicTelemetry` possui todos os campos necessários.
- Garantir que `LogService` está alinhado com o novo modelo.
2. **Fase 2: Runtime Refactor**
- Remover campos de `VirtualMachineRuntime` em `mod.rs`.
- Limpar inicialização em `lifecycle.rs`.
- Limpar loop de atualização em `tick.rs`.
3. **Fase 3: Host & Integration**
- Corrigir chamadas no `HostRunner` que ainda usem os campos antigos.
- Validar que o snapshot atômico atende às necessidades de inspeção.
4. **Fase 4: Specs & Cleanup**
- Atualizar `10-debug` e `11-portability`.
- Emitir lição aprendida LSN-0028.
## Criterios de Aceite
- O projeto compila sem warnings relacionados a campos não utilizados.
- O Host Desktop inicia e o overlay (F1) exibe telemetria correta via atômicos.
- Não existem mais os campos `telemetry_current` e `telemetry_last` no código fonte.
## Tests / Validacao
- `cargo check` em todos os crates afetados.
- Execução manual do host desktop para validar overlay.
## Riscos
- **Perda de Snapshot de Frame:** Se o `snapshot()` não for chamado no momento certo ao final do frame, o overlay pode mostrar valores parciais de ciclos (resolvido chamando `snapshot()` no Host no momento de renderização do overlay).