Struct sui_types::gas_model::tables::GasStatus

pub struct GasStatus {
    pub gas_model_version: u64,
    /* private fields */
}

The Move VM implementation of state for gas metering.

Initialize with a CostTable and the gas provided to the transaction. Provide all the proper guarantees about gas metering in the Move VM.

Every client must use an instance of this type to interact with the Move VM.

Fields

gas_model_version: u64

Implementations

impl GasStatus

pub fn new( cost_table: CostTable, budget: u64, gas_price: u64, gas_model_version: u64 ) -> Self

Initialize the gas state with metering enabled.

Charge for every operation and fail when there is no more gas to pay for operations. This is the instantiation that must be used when executing a user script.

pub fn new_unmetered() -> Self

Initialize the gas state with metering disabled.

It should be used by clients in very specific cases and when executing system code that does not have to charge the user.

pub fn push_stack(&mut self, pushes: u64) -> PartialVMResult<()>

pub fn pop_stack(&mut self, pops: u64)

pub fn increase_instruction_count(&mut self, amount: u64) -> PartialVMResult<()>

pub fn increase_stack_size(&mut self, size_amount: u64) -> PartialVMResult<()>

pub fn decrease_stack_size(&mut self, size_amount: u64)

pub fn charge( &mut self, num_instructions: u64, pushes: u64, pops: u64, incr_size: u64, _decr_size: u64 ) -> PartialVMResult<()>

Given: pushes + pops + increase + decrease in size for an instruction charge for the execution of the instruction.

pub fn cost_table(&self) -> &CostTable

Return the CostTable behind this GasStatus.

pub fn remaining_gas(&self) -> Gas

Return the gas left.

pub fn deduct_gas(&mut self, amount: InternalGas) -> PartialVMResult<()>

Charge a given amount of gas and fail if not enough gas units are left.

pub fn set_metering(&mut self, enabled: bool)

pub fn gas_used_pre_gas_price(&self) -> u64

pub fn charge_bytes( &mut self, size: usize, cost_per_byte: u64 ) -> PartialVMResult<()>

pub fn gas_price(&self) -> u64

pub fn stack_height_high_water_mark(&self) -> u64

pub fn stack_size_high_water_mark(&self) -> u64

pub fn instructions_executed(&self) -> u64

Trait Implementations

impl Debug for GasStatus

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

Formats the value using the given formatter.

impl GasMeter for GasStatus

fn charge_simple_instr( &mut self, instr: SimpleInstruction ) -> PartialVMResult<()>

Charge an instruction and fail if not enough gas units are left.

fn charge_pop(&mut self, popped_val: impl ValueView) -> PartialVMResult<()>

fn charge_native_function( &mut self, amount: InternalGas, ret_vals: Option<impl ExactSizeIterator<Item = impl ValueView>> ) -> PartialVMResult<()>

fn charge_native_function_before_execution( &mut self, _ty_args: impl ExactSizeIterator<Item = impl TypeView>, args: impl ExactSizeIterator<Item = impl ValueView> ) -> PartialVMResult<()>

fn charge_call( &mut self, _module_id: &ModuleId, _func_name: &str, args: impl ExactSizeIterator<Item = impl ValueView>, _num_locals: NumArgs ) -> PartialVMResult<()>

fn charge_call_generic( &mut self, _module_id: &ModuleId, _func_name: &str, _ty_args: impl ExactSizeIterator<Item = impl TypeView>, args: impl ExactSizeIterator<Item = impl ValueView>, _num_locals: NumArgs ) -> PartialVMResult<()>

fn charge_ld_const(&mut self, size: NumBytes) -> PartialVMResult<()>

fn charge_ld_const_after_deserialization( &mut self, _val: impl ValueView ) -> PartialVMResult<()>

fn charge_copy_loc(&mut self, val: impl ValueView) -> PartialVMResult<()>

fn charge_move_loc(&mut self, val: impl ValueView) -> PartialVMResult<()>

fn charge_store_loc(&mut self, val: impl ValueView) -> PartialVMResult<()>

fn charge_pack( &mut self, _is_generic: bool, args: impl ExactSizeIterator<Item = impl ValueView> ) -> PartialVMResult<()>

fn charge_unpack( &mut self, _is_generic: bool, args: impl ExactSizeIterator<Item = impl ValueView> ) -> PartialVMResult<()>

fn charge_read_ref(&mut self, ref_val: impl ValueView) -> PartialVMResult<()>

fn charge_write_ref( &mut self, new_val: impl ValueView, old_val: impl ValueView ) -> PartialVMResult<()>

fn charge_eq( &mut self, lhs: impl ValueView, rhs: impl ValueView ) -> PartialVMResult<()>

fn charge_neq( &mut self, lhs: impl ValueView, rhs: impl ValueView ) -> PartialVMResult<()>

fn charge_vec_pack<'a>( &mut self, _ty: impl TypeView + 'a, args: impl ExactSizeIterator<Item = impl ValueView> ) -> PartialVMResult<()>

fn charge_vec_len(&mut self, _ty: impl TypeView) -> PartialVMResult<()>

fn charge_vec_borrow( &mut self, _is_mut: bool, _ty: impl TypeView, _is_success: bool ) -> PartialVMResult<()>

fn charge_vec_push_back( &mut self, _ty: impl TypeView, _val: impl ValueView ) -> PartialVMResult<()>

fn charge_vec_pop_back( &mut self, _ty: impl TypeView, _val: Option<impl ValueView> ) -> PartialVMResult<()>

fn charge_vec_unpack( &mut self, _ty: impl TypeView, expect_num_elements: NumArgs, _elems: impl ExactSizeIterator<Item = impl ValueView> ) -> PartialVMResult<()>

fn charge_vec_swap(&mut self, _ty: impl TypeView) -> PartialVMResult<()>

fn charge_drop_frame( &mut self, _locals: impl Iterator<Item = impl ValueView> ) -> PartialVMResult<()>

fn remaining_gas(&self) -> InternalGas

Returns the gas left

fn get_profiler_mut(&mut self) -> Option<&mut GasProfiler>

fn set_profiler(&mut self, profiler: GasProfiler)