feat(bytecode): complete PLN-0176 step 08 typed PBX v1 writer

This commit is contained in:
2026-10-07 17:53:30 +01:00
parent 126a9e50e7
commit dff4041de7
4 changed files with 362 additions and 1 deletions
@@ -471,3 +471,5 @@ fn write_section(
mod payloads;
pub use payloads::ParsedPbx;
mod writer;
pub use writer::PbxModule;
@@ -153,7 +153,7 @@ impl<'a> Reader<'a, '_> {
}
self.finish()
}
fn syscalls(mut self) -> Result<(), E> {
pub(super) fn syscalls(mut self) -> Result<(), E> {
let count = self.raw_count(10)?;
let mut identities = self.budget.vector(count, Q::TemporaryBytes)?;
for i in 0..count {
@@ -0,0 +1,195 @@
//! Producer-side serialization of a complete typed module. This writer emits
//! only v1; executable consumers still need bindings and code verification.
use super::*;
use crate::load_limits::IdDomain;
use crate::model::{ConstantPoolEntry, DebugInfo, Export, SyscallDecl};
/// Borrowed producer data with already resolved Registry declarations. There
/// is no version selector, inferred signature or generic Value-to-null path.
pub struct PbxModule<'a> {
pub registry: &'a Registry,
pub constants: &'a [ConstantPoolEntry],
pub code: &'a [u8],
pub debug: Option<&'a DebugInfo>,
pub exports: &'a [Export],
pub syscalls: &'a [SyscallDecl],
}
impl PbxModule<'_> {
/// All intermediate sections coexist with the final output and are charged
/// until dropped. On success only the returned Vec capacity remains charged.
pub fn serialize(&self, budget: &mut LoadBudget) -> Result<Vec<u8>, E> {
budget.transaction(|budget| {
let temporary_before = budget.used(Q::TemporaryBytes);
budget.check(Q::CodeBytes, self.code.len() as u64)?;
for (id, function) in self.registry.declarations().functions.iter().enumerate() {
budget.work(1)?;
if u64::from(function.code_offset) + u64::from(function.code_len)
> self.code.len() as u64
{
return Err(E::new(C::InvalidCode, R::CodeRange)
.in_section(2)
.in_function(id as u32, Some(function.code_offset)));
}
}
let registry = encode_registry(self.registry, budget)?;
let constants = write_section(budget, |w| self.write_constants(w))?;
let exports = write_section(budget, |w| self.write_exports(w))?;
let syscalls = write_section(budget, |w| self.write_syscalls(w))?;
// Reuse the bounded identity validator; do not introduce a second
// native-binding catalog or an unbounded duplicate search.
Reader::new(Section { kind: 5, offset: 0, bytes: &syscalls }, budget).syscalls()?;
let debug = self
.debug
.map(|di| write_section(budget, |w| self.write_debug(di, w)))
.transpose()?;
let mut sections = [SectionData { kind: 0, bytes: &[] }; 8];
let mut count = 0;
for (kind, bytes) in [
(0, Some(constants.as_slice())),
(1, Some(registry.functions.as_slice())),
(2, Some(self.code)),
(3, debug.as_deref()),
(4, Some(exports.as_slice())),
(5, Some(syscalls.as_slice())),
(6, Some(registry.types.as_slice())),
(7, Some(registry.implementations.as_slice())),
] {
if let Some(bytes) = bytes {
sections[count] = SectionData { kind, bytes };
count += 1;
}
}
let out = encode_envelope(&sections[..count], budget)?;
// The borrowed section array and all owned intermediate Vecs die
// before return. Preserve prior scratch plus returned output only.
let retained = out.capacity() as u64;
drop(debug);
drop(syscalls);
drop(exports);
drop(constants);
drop(registry);
budget.refund(
Q::TemporaryBytes,
budget.used(Q::TemporaryBytes) - temporary_before - retained,
);
Ok(out)
})
}
fn write_constants(&self, w: &mut Writer<'_>) -> Result<(), E> {
w.budget.check(Q::ConstantEntries, self.constants.len() as u64)?;
w.count(self.constants.len())?;
let mut string_bytes = 0u64;
for (id, entry) in self.constants.iter().enumerate() {
w.budget.work(1)?;
match entry {
ConstantPoolEntry::Null => w.byte(0)?,
ConstantPoolEntry::Int64(value) => {
w.byte(1)?;
w.bytes(&value.to_le_bytes())?;
}
ConstantPoolEntry::Float64(value) => {
w.byte(2)?;
w.bytes(&value.to_bits().to_le_bytes())?;
}
ConstantPoolEntry::Boolean(value) => {
w.byte(3)?;
w.byte(u8::from(*value))?;
}
ConstantPoolEntry::String(value) => {
if value.len() as u64 > w.budget.individual_string_limit() {
return Err(E::resource(
Q::ConstantStringBytes,
value.len() as u64,
w.budget.individual_string_limit(),
)
.in_section(0)
.record(id as u32));
}
string_bytes =
string_bytes.checked_add(value.len() as u64).ok_or_else(overflow)?;
w.budget.check(Q::ConstantStringBytes, string_bytes)?;
w.byte(4)?;
w.count(value.len())?;
w.bytes(value.as_bytes())?;
}
ConstantPoolEntry::Int32(value) => {
w.byte(5)?;
w.bytes(&value.to_le_bytes())?;
}
}
}
Ok(())
}
fn check_function(&self, id: u32) -> Result<(), E> {
if id as usize >= self.registry.declarations().functions.len() {
Err(E::new(C::InvalidReference, R::FunctionId).reference(IdDomain::Function, id))
} else {
Ok(())
}
}
fn write_exports(&self, w: &mut Writer<'_>) -> Result<(), E> {
w.count(self.exports.len())?;
for (record, export) in self.exports.iter().enumerate() {
w.budget.work(1)?;
self.check_function(export.func_idx)
.map_err(|e| e.in_section(4).record(record as u32))?;
w.u32(export.func_idx)?;
w.text(&export.symbol, 4)?;
}
Ok(())
}
fn write_syscalls(&self, w: &mut Writer<'_>) -> Result<(), E> {
w.count(self.syscalls.len())?;
for syscall in self.syscalls {
w.budget.work(1)?;
w.text(&syscall.module, 2)?;
w.text(&syscall.name, 2)?;
w.bytes(&syscall.version.to_le_bytes())?;
w.bytes(&syscall.arg_slots.to_le_bytes())?;
w.bytes(&syscall.ret_slots.to_le_bytes())?;
}
Ok(())
}
fn write_debug(&self, debug: &DebugInfo, w: &mut Writer<'_>) -> Result<(), E> {
w.count(debug.pc_to_span.len())?;
for (record, (pc, span)) in debug.pc_to_span.iter().enumerate() {
w.budget.work(1)?;
if *pc as usize >= self.code.len() || span.end < span.start {
return Err(E::new(C::InvalidFormat, R::DebugRange)
.in_section(3)
.record(record as u32));
}
w.u32(*pc)?;
w.u32(span.file_id)?;
w.u32(span.start)?;
w.u32(span.end)?;
}
w.count(debug.function_names.len())?;
for (record, (id, name)) in debug.function_names.iter().enumerate() {
w.budget.work(1)?;
self.check_function(*id).map_err(|e| e.in_section(3).record(record as u32))?;
w.u32(*id)?;
w.text(name, 4)?;
}
Ok(())
}
}
impl Writer<'_> {
fn text(&mut self, value: &str, length_bytes: usize) -> Result<(), E> {
if value.len() as u64 > self.budget.individual_name_limit() {
return Err(E::resource(
Q::NameBytes,
value.len() as u64,
self.budget.individual_name_limit(),
));
}
if length_bytes == 2 {
self.bytes(&u16::try_from(value.len()).map_err(|_| overflow())?.to_le_bytes())?;
} else {
self.count(value.len())?;
}
self.bytes(value.as_bytes())
}
}
@@ -83,6 +83,170 @@ fn writer_matches_independent_minimal_envelope() {
assert_eq!(b.used(LoadResource::TemporaryBytes), 0);
assert_eq!(registry.declarations().functions[0].max_stack_slots, 0);
}
#[test]
fn complete_module_writer_matches_independent_minimal_bytes_and_refunds_scratch() {
let registry = minimal_registry();
let module = PbxModule {
registry: &registry,
constants: &[],
code: &[1, 0],
debug: None,
exports: &[],
syscalls: &[],
};
let mut b = budget();
b.charge(LoadResource::TemporaryBytes, 7).unwrap();
let bytes = module.serialize(&mut b).unwrap();
assert_eq!(bytes, minimal_bytes());
assert_eq!(b.used(LoadResource::TemporaryBytes), 7 + bytes.capacity() as u64);
assert_eq!(b.used(LoadResource::RegistryBytes), 0);
assert_eq!(b.used(LoadResource::ConstantEntries), 0);
ParsedPbx::parse(&bytes, &mut budget()).unwrap();
}
#[test]
fn complete_module_writer_preserves_non_registry_encodings() {
use prometeu_bytecode::model::{ConstantPoolEntry as K, DebugInfo, Export, SyscallDecl};
use prometeu_bytecode::SourceSpan;
let registry = minimal_registry();
let constants = [
K::Null,
K::Int64(-1),
K::Float64(f64::from_bits(0x7ff8000000001234)),
K::Boolean(true),
K::String("é".into()),
K::Int32(-2),
K::String(String::new()),
];
let debug = DebugInfo {
pc_to_span: vec![(0, SourceSpan { file_id: 7, start: 2, end: 9 })],
function_names: vec![(0, String::new())],
};
let exports = [Export { symbol: "boot".into(), func_idx: 0 }];
let syscalls = [SyscallDecl {
module: "m".into(),
name: "n".into(),
version: 3,
arg_slots: 2,
ret_slots: 1,
}];
let module = PbxModule {
registry: &registry,
constants: &constants,
code: &[1, 0],
debug: Some(&debug),
exports: &exports,
syscalls: &syscalls,
};
let bytes = module.serialize(&mut budget()).unwrap();
let parsed = ParsedPbx::parse(&bytes, &mut budget()).unwrap();
assert_eq!(
parsed.section(0).unwrap().bytes,
hex("07 00 00 00 00
01 ff ff ff ff ff ff ff ff
02 34 12 00 00 00 00 f8 7f
03 01 04 02 00 00 00 c3 a9 05 fe ff ff ff 04 00 00 00 00")
);
assert_eq!(
parsed.section(3).unwrap().bytes,
hex("01 00 00 00 00 00 00 00
07 00 00 00 02 00 00 00 09 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00")
);
assert_eq!(
parsed.section(4).unwrap().bytes,
hex("01 00 00 00 00 00 00 00 04 00 00 00 62 6f 6f 74")
);
assert_eq!(
parsed.section(5).unwrap().bytes,
hex("01 00 00 00 01 00 6d 01 00 6e 03 00 02 00 01 00")
);
}
#[test]
fn complete_module_writer_rejects_invalid_payload_records_without_retaining_scratch() {
use prometeu_bytecode::model::{DebugInfo, Export, SyscallDecl};
use prometeu_bytecode::SourceSpan;
let registry = minimal_registry();
let bad_export = [Export { symbol: "bad".into(), func_idx: u32::MAX }];
let syscall = SyscallDecl { module: "m".into(), name: "n".into(), ..Default::default() };
let duplicates = [syscall.clone(), syscall];
let bad_debug = DebugInfo {
pc_to_span: vec![(2, SourceSpan { file_id: 0, start: 0, end: 1 })],
..Default::default()
};
for (exports, syscalls, debug, reason) in [
(&bad_export[..], &[][..], None, LoadReason::FunctionId),
(&[][..], &duplicates[..], None, LoadReason::DuplicateSyscall),
(&[][..], &[][..], Some(&bad_debug), LoadReason::DebugRange),
] {
let mut b = budget();
b.charge(LoadResource::TemporaryBytes, 7).unwrap();
let e = PbxModule {
registry: &registry,
constants: &[],
code: &[1, 0],
debug,
exports,
syscalls,
}
.serialize(&mut b)
.unwrap_err();
assert_eq!(e.reason, reason);
assert_eq!(b.used(LoadResource::TemporaryBytes), 7);
assert!(b.used(LoadResource::Work) > 0);
}
}
#[test]
fn complete_module_writer_checks_constant_quotas_before_payload_allocation() {
use prometeu_bytecode::model::ConstantPoolEntry as K;
let registry = minimal_registry();
let constants = [K::String("abc".into()), K::String("abc".into())];
let module = PbxModule {
registry: &registry,
constants: &constants,
code: &[1, 0],
debug: None,
exports: &[],
syscalls: &[],
};
for (resource, limit) in [
(LoadResource::ConstantEntries, 1),
(LoadResource::ConstantStringBytes, 5),
(LoadResource::TemporaryBytes, 1),
] {
let mut limits = LoadLimits::default();
match resource {
LoadResource::ConstantEntries => limits.constant_entries = limit,
LoadResource::ConstantStringBytes => limits.constant_string_bytes = limit,
LoadResource::TemporaryBytes => limits.temporary_bytes = limit,
_ => unreachable!(),
}
let mut b = LoadBudget::new(limits);
let error = module.serialize(&mut b).unwrap_err();
assert_eq!(error.code, LoadCode::ResourceLimit);
assert_eq!(error.resource, Some(resource));
assert_eq!(b.used(LoadResource::TemporaryBytes), 0);
}
}
#[test]
fn complete_module_writer_rejects_code_range_mismatch() {
let registry = minimal_registry();
let e = PbxModule {
registry: &registry,
constants: &[],
code: &[],
debug: None,
exports: &[],
syscalls: &[],
}
.serialize(&mut budget())
.unwrap_err();
assert_eq!((e.code, e.reason), (LoadCode::InvalidCode, LoadReason::CodeRange));
assert_eq!((e.function, e.pc), (Some(0), Some(0)));
}
#[test]
fn representative_records_match_fixed_bytes_and_preserve_names_without_debug() {
let types = hex("