Struct polkavm_common::program::ProgramBlob

pub struct ProgramBlob<'a> { /* private fields */ }

A partially deserialized PolkaVM program.

Implementations

impl<'a> ProgramBlob<'a>

pub fn parse(bytes: impl Into<CowBytes<'a>>) -> Result<Self, ProgramParseError>

Parses the given bytes into a program blob.

pub fn as_bytes(&self) -> &[u8]

Returns the original bytes from which this program blob was created from.

pub fn ro_data(&self) -> &[u8]

Returns the contents of the read-only data section.

This only covers the initial non-zero portion of the section; use ro_data_size to get the full size.

pub fn ro_data_size(&self) -> u32

Returns the size of the read-only data section.

This can be larger than the length of ro_data, in which case the rest of the space is assumed to be filled with zeros.

pub fn rw_data(&self) -> &[u8]

Returns the contents of the read-write data section.

This only covers the initial non-zero portion of the section; use rw_data_size to get the full size.

pub fn rw_data_size(&self) -> u32

Returns the size of the read-write data section.

This can be larger than the length of rw_data, in which case the rest of the space is assumed to be filled with zeros.

pub fn stack_size(&self) -> u32

Returns the initial size of the stack.

pub fn code(&self) -> &[u8]

Returns the program code in its raw form.

pub fn instruction_count(&self) -> u32

Returns the number of instructions the code section should contain.

NOTE: It is safe to preallocate memory based on this value as we make sure that it is no larger than the the physical size of the code section, however we do not verify that it is actually true, so it should not be blindly trusted!

pub fn basic_block_count(&self) -> u32

Returns the number of basic blocks the code section should contain.

NOTE: It is safe to preallocate memory based on this value as we make sure that it is no larger than the the physical size of the code section, however we do not verify that it is actually true, so it should not be blindly trusted!

pub fn imports( &self ) -> impl Iterator<Item = Result<ProgramImport<'_>, ProgramParseError>> + Clone + '_

Returns an iterator over program imports.

pub fn exports( &self ) -> impl Iterator<Item = Result<ProgramExport<'_>, ProgramParseError>> + Clone + '_

Returns an iterator over program exports.

pub fn instructions( &self ) -> impl Iterator<Item = Result<Instruction, ProgramParseError>> + Clone + '_

Returns an iterator over program instructions.

pub fn jump_table_upper_bound(&self) -> usize

The upper bound of how many entries there might be in this program’s jump table, excluding the very first implicit entry.

pub fn jump_table( &self ) -> impl Iterator<Item = Result<u32, ProgramParseError>> + Clone + '_

Returns an iterator over the jump table entries, excluding the very first implicit entry.

pub fn get_debug_string(&self, offset: u32) -> Result<&str, ProgramParseError>

Returns the debug string for the given relative offset.

pub fn get_debug_line_program_at( &self, nth_instruction: u32 ) -> Result<Option<LineProgram<'_>>, ProgramParseError>

Returns the line program for the given instruction.

Trait Implementations

impl<'a> Clone for ProgramBlob<'a>

fn clone(&self) -> ProgramBlob<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for ProgramBlob<'a>

fn default() -> ProgramBlob<'a>

Returns the “default value” for a type.