Skip to content

Commit

Permalink
Switch from pwasm-utils to wasm-instrument (paritytech#10680)
Browse files Browse the repository at this point in the history
* Switch executor to wasm-instrument

* Switch pallet-contracts to wasm-instrument
  • Loading branch information
athei authored and ark0f committed Feb 27, 2023
1 parent 23625ec commit 55d3cb8
Show file tree
Hide file tree
Showing 12 changed files with 47 additions and 48 deletions.
24 changes: 11 additions & 13 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion client/executor/common/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ targets = ["x86_64-unknown-linux-gnu"]

[dependencies]
derive_more = "0.99.16"
pwasm-utils = "0.18.2"
wasm-instrument = "0.1"
codec = { package = "parity-scale-codec", version = "2.0.0" }
wasmi = "0.9.1"
sp-core = { version = "4.1.0-dev", path = "../../../primitives/core" }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@

use super::RuntimeBlob;
use crate::error::{self, Error};
use pwasm_utils::parity_wasm::elements::Instruction;
use std::mem;
use wasm_instrument::parity_wasm::elements::Instruction;

/// This is a snapshot of data segments specialzied for a particular instantiation.
///
Expand Down
4 changes: 2 additions & 2 deletions client/executor/common/src/runtime_blob/runtime_blob.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
// along with this program. If not, see <https://www.gnu.org/licenses/>.

use crate::error::WasmError;
use pwasm_utils::{
use wasm_instrument::{
export_mutable_globals,
parity_wasm::elements::{deserialize_buffer, serialize, DataSegment, Internal, Module},
};
Expand Down Expand Up @@ -84,7 +84,7 @@ impl RuntimeBlob {
/// depth of the wasm operand stack.
pub fn inject_stack_depth_metering(self, stack_depth_limit: u32) -> Result<Self, WasmError> {
let injected_module =
pwasm_utils::stack_height::inject_limiter(self.raw_module, stack_depth_limit).map_err(
wasm_instrument::inject_stack_limiter(self.raw_module, stack_depth_limit).map_err(
|e| WasmError::Other(format!("cannot inject the stack limiter: {:?}", e)),
)?;

Expand Down
4 changes: 2 additions & 2 deletions frame/contracts/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ codec = { package = "parity-scale-codec", version = "2.2.0", default-features =
] }
scale-info = { version = "1.0", default-features = false, features = ["derive"] }
log = { version = "0.4", default-features = false }
pwasm-utils = { version = "0.18.2", default-features = false }
wasm-instrument = { version = "0.1", default-features = false }
serde = { version = "1", optional = true, features = ["derive"] }
smallvec = { version = "1", default-features = false, features = [
"const_generics",
Expand Down Expand Up @@ -71,7 +71,7 @@ std = [
"frame-benchmarking/std",
"frame-support/std",
"frame-system/std",
"pwasm-utils/std",
"wasm-instrument/std",
"wasmi-validation/std",
"pallet-contracts-primitives/std",
"pallet-contracts-proc-macro/full",
Expand Down
18 changes: 9 additions & 9 deletions frame/contracts/src/benchmarking/code.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,20 @@

use crate::Config;
use frame_support::traits::Get;
use pwasm_utils::parity_wasm::{
builder,
elements::{
self, BlockType, CustomSection, External, FuncBody, Instruction, Instructions, Module,
Section, ValueType,
},
};
use sp_core::crypto::UncheckedFrom;
use sp_runtime::traits::Hash;
use sp_sandbox::{
default_executor::{EnvironmentDefinitionBuilder, Memory},
SandboxEnvironmentBuilder, SandboxMemory,
};
use sp_std::{borrow::ToOwned, prelude::*};
use wasm_instrument::parity_wasm::{
builder,
elements::{
self, BlockType, CustomSection, External, FuncBody, Instruction, Instructions, Module,
Section, ValueType,
},
};

/// The location where to put the genrated code.
pub enum Location {
Expand Down Expand Up @@ -562,10 +562,10 @@ where
fn inject_gas_metering<T: Config>(module: Module) -> Module {
let schedule = T::Schedule::get();
let gas_rules = schedule.rules(&module);
pwasm_utils::inject_gas_counter(module, &gas_rules, "seal0").unwrap()
wasm_instrument::gas_metering::inject(module, &gas_rules, "seal0").unwrap()
}

fn inject_stack_metering<T: Config>(module: Module) -> Module {
let height = T::Schedule::get().limits.stack_height;
pwasm_utils::stack_height::inject_limiter(module, height).unwrap()
wasm_instrument::inject_stack_limiter(module, height).unwrap()
}
2 changes: 1 addition & 1 deletion frame/contracts/src/benchmarking/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ use codec::Encode;
use frame_benchmarking::{account, benchmarks, whitelisted_caller};
use frame_support::weights::Weight;
use frame_system::RawOrigin;
use pwasm_utils::parity_wasm::elements::{BlockType, BrTableData, Instruction, ValueType};
use sp_runtime::{
traits::{Bounded, Hash},
Perbill,
};
use sp_std::prelude::*;
use wasm_instrument::parity_wasm::elements::{BlockType, BrTableData, Instruction, ValueType};

/// How many batches we do per API benchmark.
const API_BENCHMARK_BATCHES: u32 = 20;
Expand Down
10 changes: 5 additions & 5 deletions frame/contracts/src/schedule.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ use crate::{weights::WeightInfo, Config};
use codec::{Decode, Encode};
use frame_support::{weights::Weight, DefaultNoBound};
use pallet_contracts_proc_macro::{ScheduleDebug, WeightDebug};
use pwasm_utils::{parity_wasm::elements, rules};
use scale_info::TypeInfo;
#[cfg(feature = "std")]
use serde::{Deserialize, Serialize};
use sp_runtime::RuntimeDebug;
use sp_std::{marker::PhantomData, vec::Vec};
use wasm_instrument::{gas_metering, parity_wasm::elements};

/// How many API calls are executed in a single batch. The reason for increasing the amount
/// of API calls in batches (per benchmark component increase) is so that the linear regression
Expand Down Expand Up @@ -652,7 +652,7 @@ struct ScheduleRules<'a, T: Config> {
}

impl<T: Config> Schedule<T> {
pub(crate) fn rules(&self, module: &elements::Module) -> impl rules::Rules + '_ {
pub(crate) fn rules(&self, module: &elements::Module) -> impl gas_metering::Rules + '_ {
ScheduleRules {
schedule: &self,
params: module
Expand All @@ -668,7 +668,7 @@ impl<T: Config> Schedule<T> {
}
}

impl<'a, T: Config> rules::Rules for ScheduleRules<'a, T> {
impl<'a, T: Config> gas_metering::Rules for ScheduleRules<'a, T> {
fn instruction_cost(&self, instruction: &elements::Instruction) -> Option<u32> {
use self::elements::Instruction::*;
let w = &self.schedule.instruction_weights;
Expand Down Expand Up @@ -752,10 +752,10 @@ impl<'a, T: Config> rules::Rules for ScheduleRules<'a, T> {
Some(weight)
}

fn memory_grow_cost(&self) -> Option<rules::MemoryGrowCost> {
fn memory_grow_cost(&self) -> gas_metering::MemoryGrowCost {
// We benchmarked the memory.grow instruction with the maximum allowed pages.
// The cost for growing is therefore already included in the instruction cost.
None
gas_metering::MemoryGrowCost::Free
}
}

Expand Down
8 changes: 4 additions & 4 deletions frame/contracts/src/wasm/env_def/macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ macro_rules! convert_args {
macro_rules! gen_signature {
( ( $( $params: ty ),* ) ) => (
{
pwasm_utils::parity_wasm::elements::FunctionType::new(
wasm_instrument::parity_wasm::elements::FunctionType::new(
convert_args!($($params),*), vec![],
)
}
);

( ( $( $params: ty ),* ) -> $returns: ty ) => (
{
pwasm_utils::parity_wasm::elements::FunctionType::new(
wasm_instrument::parity_wasm::elements::FunctionType::new(
convert_args!($($params),*),
vec![{use $crate::wasm::env_def::ConvertibleToWasm; <$returns>::VALUE_TYPE}],
)
Expand Down Expand Up @@ -220,7 +220,7 @@ macro_rules! define_env {
fn can_satisfy(
module: &[u8],
name: &[u8],
func_type: &pwasm_utils::parity_wasm::elements::FunctionType,
func_type: &wasm_instrument::parity_wasm::elements::FunctionType,
) -> bool
{
#[cfg(not(feature = "unstable-interface"))]
Expand Down Expand Up @@ -260,9 +260,9 @@ mod tests {
wasm::{runtime::TrapReason, tests::MockExt, Runtime},
Weight,
};
use pwasm_utils::parity_wasm::elements::{FunctionType, ValueType};
use sp_runtime::traits::Zero;
use sp_sandbox::{ReturnValue, Value};
use wasm_instrument::parity_wasm::elements::{FunctionType, ValueType};

struct TestRuntime {
value: u32,
Expand Down
2 changes: 1 addition & 1 deletion frame/contracts/src/wasm/env_def/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
use super::Runtime;
use crate::exec::Ext;

use pwasm_utils::parity_wasm::elements::{FunctionType, ValueType};
use sp_sandbox::Value;
use wasm_instrument::parity_wasm::elements::{FunctionType, ValueType};

#[macro_use]
pub mod macros;
Expand Down
17 changes: 9 additions & 8 deletions frame/contracts/src/wasm/prepare.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ use crate::{
AccountIdOf, Config, Schedule,
};
use codec::{Encode, MaxEncodedLen};
use pwasm_utils::parity_wasm::elements::{self, External, Internal, MemoryType, Type, ValueType};
use sp_runtime::traits::Hash;
use sp_std::prelude::*;
use wasm_instrument::parity_wasm::elements::{
self, External, Internal, MemoryType, Type, ValueType,
};

/// Imported memory must be located inside this module. The reason for hardcoding is that current
/// compiler toolchains might not support specifying other modules than "env" for memory imports.
Expand Down Expand Up @@ -182,17 +184,16 @@ impl<'a, T: Config> ContractModule<'a, T> {

fn inject_gas_metering(self) -> Result<Self, &'static str> {
let gas_rules = self.schedule.rules(&self.module);
let contract_module = pwasm_utils::inject_gas_counter(self.module, &gas_rules, "seal0")
.map_err(|_| "gas instrumentation failed")?;
let contract_module =
wasm_instrument::gas_metering::inject(self.module, &gas_rules, "seal0")
.map_err(|_| "gas instrumentation failed")?;
Ok(ContractModule { module: contract_module, schedule: self.schedule })
}

fn inject_stack_height_metering(self) -> Result<Self, &'static str> {
let contract_module = pwasm_utils::stack_height::inject_limiter(
self.module,
self.schedule.limits.stack_height,
)
.map_err(|_| "stack height instrumentation failed")?;
let contract_module =
wasm_instrument::inject_stack_limiter(self.module, self.schedule.limits.stack_height)
.map_err(|_| "stack height instrumentation failed")?;
Ok(ContractModule { module: contract_module, schedule: self.schedule })
}

Expand Down
2 changes: 1 addition & 1 deletion frame/contracts/src/wasm/runtime.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ use bitflags::bitflags;
use codec::{Decode, DecodeAll, Encode, MaxEncodedLen};
use frame_support::{dispatch::DispatchError, ensure, weights::Weight};
use pallet_contracts_primitives::{ExecReturnValue, ReturnFlags};
use pwasm_utils::parity_wasm::elements::ValueType;
use sp_core::{crypto::UncheckedFrom, Bytes};
use sp_io::hashing::{blake2_128, blake2_256, keccak_256, sha2_256};
use sp_runtime::traits::{Bounded, Zero};
use sp_sandbox::SandboxMemory;
use sp_std::prelude::*;
use wasm_instrument::parity_wasm::elements::ValueType;

/// Every error that can be returned to a contract when it calls any of the host functions.
///
Expand Down

0 comments on commit 55d3cb8

Please sign in to comment.