Struct cranelift_wasm::wasmparser::FuncValidator

source ·
pub struct FuncValidator<T> { /* private fields */ }
Expand description

Validation context for a WebAssembly function.

This is a finalized validator which is ready to process a FunctionBody. This is created from the FuncToValidate::into_validator method.

Implementations§

source§

impl<T> FuncValidator<T>

source

pub fn validate( &mut self, body: &FunctionBody<'_>, ) -> Result<(), BinaryReaderError>

Convenience function to validate an entire function’s body.

You may not end up using this in final implementations because you’ll often want to interleave validation with parsing.

source

pub fn read_locals( &mut self, reader: &mut BinaryReader<'_>, ) -> Result<(), BinaryReaderError>

Reads the local definitions from the given BinaryReader, often sourced from a FunctionBody.

This function will automatically advance the BinaryReader forward, leaving reading operators up to the caller afterwards.

source

pub fn define_locals( &mut self, offset: usize, count: u32, ty: ValType, ) -> Result<(), BinaryReaderError>

Defines locals into this validator.

This should be used if the application is already reading local definitions and there’s no need to re-parse the function again.

source

pub fn op( &mut self, offset: usize, operator: &Operator<'_>, ) -> Result<(), BinaryReaderError>

Validates the next operator in a function.

This functions is expected to be called once-per-operator in a WebAssembly function. Each operator’s offset in the original binary and the operator itself are passed to this function to provide more useful error messages.

source

pub fn visitor<'this, 'a>( &'this mut self, offset: usize, ) -> impl VisitOperator<'a, Output = Result<(), BinaryReaderError>> + 'this
where 'a: 'this,

Get the operator visitor for the next operator in the function.

The returned visitor is intended to visit just one instruction at the offset.

§Example
pub fn validate<R>(validator: &mut FuncValidator<R>, body: &FunctionBody<'_>) -> Result<()>
where R: WasmModuleResources
{
    let mut operator_reader = body.get_binary_reader();
    while !operator_reader.eof() {
        let mut visitor = validator.visitor(operator_reader.original_position());
        operator_reader.visit_operator(&mut visitor)??;
    }
    validator.finish(operator_reader.original_position())
}
source

pub fn finish(&mut self, offset: usize) -> Result<(), BinaryReaderError>

Function that must be called after the last opcode has been processed.

This will validate that the function was properly terminated with the end opcode. If this function is not called then the function will not be properly validated.

The offset provided to this function will be used as a position for an error if validation fails.

source

pub fn resources(&self) -> &T

Returns the underlying module resources that this validator is using.

source

pub fn index(&self) -> u32

The index of the function within the module’s function index space that is being validated.

source

pub fn len_locals(&self) -> u32

Returns the number of defined local variables in the function.

source

pub fn get_local_type(&self, index: u32) -> Option<ValType>

Returns the type of the local variable at the given index if any.

source

pub fn operand_stack_height(&self) -> u32

Get the current height of the operand stack.

This returns the height of the whole operand stack for this function, not just for the current control frame.

source

pub fn get_operand_type(&self, depth: usize) -> Option<Option<ValType>>

Returns the optional value type of the value operand at the given depth from the top of the operand stack.

  • Returns None if the depth is out of bounds.
  • Returns Some(None) if there is a value with unknown type at the given depth.
§Note

A depth of 0 will refer to the last operand on the stack.

source

pub fn control_stack_height(&self) -> u32

Returns the number of frames on the control flow stack.

This returns the height of the whole control stack for this function, not just for the current control frame.

source

pub fn get_control_frame(&self, depth: usize) -> Option<&Frame>

Returns a shared reference to the control flow Frame of the control flow stack at the given depth if any.

Returns None if the depth is out of bounds.

§Note

A depth of 0 will refer to the last frame on the stack.

source

pub fn into_allocations(self) -> FuncValidatorAllocations

Consumes this validator and returns the underlying allocations that were used during the validation process.

The returned value here can be paired with FuncToValidate::into_validator to reuse the allocations already created by this validator.

Auto Trait Implementations§

§

impl<T> Freeze for FuncValidator<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for FuncValidator<T>
where T: RefUnwindSafe,

§

impl<T> Send for FuncValidator<T>
where T: Send,

§

impl<T> Sync for FuncValidator<T>
where T: Sync,

§

impl<T> Unpin for FuncValidator<T>
where T: Unpin,

§

impl<T> UnwindSafe for FuncValidator<T>
where T: UnwindSafe,

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> 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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

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

§

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>,

§

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.