Skip to main content

ProgramBlob

Struct ProgramBlob 

Source
pub struct ProgramBlob {
    pub code: Vec<u8>,
    pub regions: Regions,
    pub ro_data: Vec<u8>,
    pub rw_data: Vec<u8>,
    pub endpoints: BTreeMap<u8, Endpoint>,
}
Expand description

A self-contained PVM2 program: raw code plus the region geometry and initial contents a runtime needs to build its address space.

This is the personality-free artifact the linker emits. A capability-based personality may wrap it — JAVM’s cap Image is one such wrapping, adding cnode slots, content hashing and an SSZ encoding — but nothing here knows about capabilities.

§Invariants

ProgramBlob::new establishes and ProgramBlob::validate re-checks:

  • ro_data.len() == regions.ro_pages * PAGE_SIZE
  • rw_data.len() == regions.rw_pages * PAGE_SIZE
  • code.len() <= MAX_CODE_SIZE
  • regions.data_end() <= ADDRESS_SPACE_END
  • at least one endpoint

Stack and heap have no backing bytes: they are zero-initialized.

Fields§

§code: Vec<u8>

PVM2 bytecode, mapped read-only at abi::CODE_BASE.

§regions: Regions

Page counts for the four data regions.

§ro_data: Vec<u8>

Read-only region contents, exactly ro_pages * PAGE_SIZE bytes.

§rw_data: Vec<u8>

Read-write region contents, exactly rw_pages * PAGE_SIZE bytes.

§endpoints: BTreeMap<u8, Endpoint>

Exported entry points, keyed by endpoint index.

Implementations§

Source§

impl ProgramBlob

Source

pub fn new( code: Vec<u8>, regions: Regions, ro_data: Vec<u8>, rw_data: Vec<u8>, endpoints: BTreeMap<u8, Endpoint>, ) -> Result<Self, InvalidProgram>

Build a blob, zero-extending ro_data/rw_data to their page counts so the length invariants hold, then validate.

The linker hands over .rodata/.data+.bss buffers whose lengths are whatever the ELF sections were; normalizing to whole pages here is what makes encode/decode round-trip exactly.

Source

pub fn validate(&self) -> Result<(), InvalidProgram>

Re-check the documented invariants.

Source

pub fn region_data(&self, kind: RegionKind) -> Option<&[u8]>

The backing bytes for kind, or None for the zero-initialized stack and heap regions.

Source

pub fn memory_image(&self) -> Vec<u8>

Materialize the flat data image a runtime maps at DATA_BASE: regions.data_extent() bytes, with each region’s backing bytes at its offset and everything else zero.

Source§

impl ProgramBlob

Source

pub fn to_bytes(&self) -> Vec<u8>

Serialize to the format documented on this module.

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self, DecodeError>

Parse bytes produced by ProgramBlob::to_bytes.

Rejects trailing bytes: a blob is a whole file, and silently ignoring a suffix would hide a truncated or concatenated write.

Trait Implementations§

Source§

impl Clone for ProgramBlob

Source§

fn clone(&self) -> ProgramBlob

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ProgramBlob

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ProgramBlob

Source§

fn default() -> ProgramBlob

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ProgramBlob

Source§

fn eq(&self, other: &ProgramBlob) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for ProgramBlob

Source§

impl StructuralPartialEq for ProgramBlob

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.