release resolc v0.1.0-dev.14 (#289)

Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>

CHANGELOG.md

@@ -10,6 +10,21 @@ Supported `polkadot-sdk` rev:`c29e72a8628835e34deb6aa7db9a78a2e4eabcee`
 
 ### Changed
 
+### Fixed
+
+## v0.1.0-dev.14
+
+This is a development pre-release.
+
+Supported `polkadot-sdk` rev:`c29e72a8628835e34deb6aa7db9a78a2e4eabcee`
+
+### Added
+- The `revive-runner` helper utility binary which helps to run contracts locally without a blockchain node. 
+- Allow configuration of the EVM heap memory size and stack size via CLI flags and JSON input settings.
+
+### Changed
+- The default PVM stack memory size was increased from 16kb to 32kb.
+
 ### Fixed
 - Constructors avoid storing zero sized immutable data on exit.
 

Cargo.lock

@@ -4553,7 +4553,7 @@ checksum = "4ee93343901ab17bd981295f2cf0026d4ad018c7c31ba84549a4ddbb47a45104"
 
 [[package]]
 name = "lld-sys"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "cc",
  "libc",
@@ -8266,7 +8266,7 @@ dependencies = [
 
 [[package]]
 name = "revive-benchmarks"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "alloy-primitives",
  "criterion",
@@ -8278,18 +8278,18 @@ dependencies = [
 
 [[package]]
 name = "revive-build-utils"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 
 [[package]]
 name = "revive-builtins"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "revive-build-utils",
 ]
 
 [[package]]
 name = "revive-common"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "anyhow",
  "serde",
@@ -8299,7 +8299,7 @@ dependencies = [
 
 [[package]]
 name = "revive-differential"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "alloy-genesis",
  "alloy-primitives",
@@ -8312,7 +8312,7 @@ dependencies = [
 
 [[package]]
 name = "revive-integration"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "alloy-primitives",
  "alloy-sol-types",
@@ -8328,7 +8328,7 @@ dependencies = [
 
 [[package]]
 name = "revive-linker"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "anyhow",
  "libc",
@@ -8340,7 +8340,7 @@ dependencies = [
 
 [[package]]
 name = "revive-llvm-builder"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "anyhow",
  "assert_cmd",
@@ -8362,7 +8362,7 @@ dependencies = [
 
 [[package]]
 name = "revive-llvm-context"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "anyhow",
  "hex",
@@ -8384,9 +8384,12 @@ dependencies = [
 
 [[package]]
 name = "revive-runner"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "alloy-primitives",
+ "anyhow",
+ "clap",
+ "env_logger 0.11.6",
  "hex",
  "parity-scale-codec",
  "polkadot-sdk 0.1.0",
@@ -8400,7 +8403,7 @@ dependencies = [
 
 [[package]]
 name = "revive-runtime-api"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "anyhow",
  "inkwell",
@@ -8410,7 +8413,7 @@ dependencies = [
 
 [[package]]
 name = "revive-solc-json-interface"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "anyhow",
  "rayon",
@@ -8422,7 +8425,7 @@ dependencies = [
 
 [[package]]
 name = "revive-solidity"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "anyhow",
  "clap",
@@ -8449,7 +8452,7 @@ dependencies = [
 
 [[package]]
 name = "revive-stdlib"
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 dependencies = [
  "inkwell",
  "revive-build-utils",

Cargo.toml

@@ -3,7 +3,7 @@ resolver = "2"
 members = ["crates/*"]
 
 [workspace.package]
-version = "0.1.0-dev.13"
+version = "0.1.0-dev.14"
 authors = [
     "Cyrill Leutwiler <cyrill@parity.io>",
     "Parity Technologies <admin@parity.io>",
@@ -14,20 +14,20 @@ repository = "https://github.com/paritytech/revive"
 rust-version = "1.81.0"
 
 [workspace.dependencies]
-revive-benchmarks = { version = "0.1.0-dev.13", path = "crates/benchmarks" }
-revive-builtins = { version = "0.1.0-dev.13", path = "crates/builtins" }
-revive-common = { version = "0.1.0-dev.13", path = "crates/common" }
-revive-differential = { version = "0.1.0-dev.13", path = "crates/differential" }
-revive-integration = { version = "0.1.0-dev.13", path = "crates/integration" }
-revive-linker = { version = "0.1.0-dev.13", path = "crates/linker" }
-lld-sys = { version = "0.1.0-dev.13", path = "crates/lld-sys" }
-revive-llvm-context = { version = "0.1.0-dev.13", path = "crates/llvm-context" }
-revive-runtime-api = { version = "0.1.0-dev.13", path = "crates/runtime-api" }
-revive-runner = { version = "0.1.0-dev.13", path = "crates/runner" }
-revive-solc-json-interface = { version = "0.1.0-dev.13", path = "crates/solc-json-interface" }
-revive-solidity = { version = "0.1.0-dev.13", path = "crates/solidity" }
-revive-stdlib = { version = "0.1.0-dev.13", path = "crates/stdlib" }
-revive-build-utils = { version = "0.1.0-dev.13", path = "crates/build-utils" }
+revive-benchmarks = { version = "0.1.0-dev.14", path = "crates/benchmarks" }
+revive-builtins = { version = "0.1.0-dev.14", path = "crates/builtins" }
+revive-common = { version = "0.1.0-dev.14", path = "crates/common" }
+revive-differential = { version = "0.1.0-dev.14", path = "crates/differential" }
+revive-integration = { version = "0.1.0-dev.14", path = "crates/integration" }
+revive-linker = { version = "0.1.0-dev.14", path = "crates/linker" }
+lld-sys = { version = "0.1.0-dev.14", path = "crates/lld-sys" }
+revive-llvm-context = { version = "0.1.0-dev.14", path = "crates/llvm-context" }
+revive-runtime-api = { version = "0.1.0-dev.14", path = "crates/runtime-api" }
+revive-runner = { version = "0.1.0-dev.14", path = "crates/runner" }
+revive-solc-json-interface = { version = "0.1.0-dev.14", path = "crates/solc-json-interface" }
+revive-solidity = { version = "0.1.0-dev.14", path = "crates/solidity" }
+revive-stdlib = { version = "0.1.0-dev.14", path = "crates/stdlib" }
+revive-build-utils = { version = "0.1.0-dev.14", path = "crates/build-utils" }
 
 hex = "0.4.3"
 cc = "1.2"

Makefile

@@ -5,6 +5,7 @@
 	install-wasm \
 	install-llvm-builder \
 	install-llvm \
+	install-revive-runner \
 	format \
 	clippy \
 	machete \
@@ -39,6 +40,9 @@ install-llvm: install-llvm-builder
 	revive-llvm clone
 	revive-llvm build --llvm-projects lld --llvm-projects clang
 
+install-revive-runner:
+	cargo install --path crates/runner --no-default-features --locked
+
 format:
 	cargo fmt --all --check
 
@@ -49,7 +53,7 @@ machete:
 	cargo install cargo-machete
 	cargo machete
 
-test: format clippy machete test-cli test-workspace
+test: format clippy machete test-cli test-workspace install-revive-runner
 
 test-integration: install-bin
 	cargo test --package revive-integration

crates/integration/codesize.json

@@ -1,10 +1,10 @@
 {
-  "Baseline": 950,
-  "Computation": 2222,
-  "DivisionArithmetics": 8802,
-  "ERC20": 17602,
-  "Events": 1628,
-  "FibonacciIterative": 1485,
-  "Flipper": 2082,
-  "SHA1": 8230
+  "Baseline": 939,
+  "Computation": 2282,
+  "DivisionArithmetics": 8849,
+  "ERC20": 18308,
+  "Events": 1640,
+  "FibonacciIterative": 1497,
+  "Flipper": 2099,
+  "SHA1": 8243
 }

crates/llvm-context/src/lib.rs

@@ -5,6 +5,7 @@ use std::sync::OnceLock;
 
 pub use self::debug_config::ir_type::IRType as DebugConfigIR;
 pub use self::debug_config::DebugConfig;
+pub use self::memory::MemoryConfig;
 pub use self::optimizer::settings::size_level::SizeLevel as OptimizerSettingsSizeLevel;
 pub use self::optimizer::settings::Settings as OptimizerSettings;
 pub use self::optimizer::Optimizer;
@@ -28,6 +29,7 @@ pub use self::polkavm::context::function::runtime::entry::Entry as PolkaVMEntryF
 pub use self::polkavm::context::function::runtime::revive::Exit as PolkaVMExitFunction;
 pub use self::polkavm::context::function::runtime::revive::WordToPointer as PolkaVMWordToPointerFunction;
 pub use self::polkavm::context::function::runtime::runtime_code::RuntimeCode as PolkaVMRuntimeCodeFunction;
+pub use self::polkavm::context::function::runtime::sbrk::Sbrk as PolkaVMSbrkFunction;
 pub use self::polkavm::context::function::runtime::FUNCTION_DEPLOY_CODE as PolkaVMFunctionDeployCode;
 pub use self::polkavm::context::function::runtime::FUNCTION_ENTRY as PolkaVMFunctionEntry;
 pub use self::polkavm::context::function::runtime::FUNCTION_RUNTIME_CODE as PolkaVMFunctionRuntimeCode;
@@ -60,7 +62,6 @@ pub use self::polkavm::evm::ext_code as polkavm_evm_ext_code;
 pub use self::polkavm::evm::immutable as polkavm_evm_immutable;
 pub use self::polkavm::evm::immutable::Load as PolkaVMLoadImmutableDataFunction;
 pub use self::polkavm::evm::immutable::Store as PolkaVMStoreImmutableDataFunction;
-
 pub use self::polkavm::evm::math as polkavm_evm_math;
 pub use self::polkavm::evm::memory as polkavm_evm_memory;
 pub use self::polkavm::evm::r#return as polkavm_evm_return;
@@ -75,6 +76,7 @@ pub use self::target_machine::target::Target;
 pub use self::target_machine::TargetMachine;
 
 pub(crate) mod debug_config;
+pub(crate) mod memory;
 pub(crate) mod optimizer;
 pub(crate) mod polkavm;
 pub(crate) mod target_machine;

crates/llvm-context/src/memory.rs

@@ -0,0 +1,21 @@
+//! The compile time PolkaVM memory configuration settings.
+
+use serde::{Deserialize, Serialize};
+
+/// The PolkaVM memory configuration.
+#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
+pub struct MemoryConfig {
+    /// The emulated EVM linear heap memory size in bytes.
+    pub heap_size: u32,
+    /// The PVM stack size in bytes.
+    pub stack_size: u32,
+}
+
+impl Default for MemoryConfig {
+    fn default() -> Self {
+        Self {
+            heap_size: 64 * 1024,
+            stack_size: 32 * 1024,
+        }
+    }
+}

crates/llvm-context/src/polkavm/const/mod.rs

@@ -9,6 +9,12 @@ pub static XLEN: usize = revive_common::BIT_LENGTH_X32;
 /// The calldata size global variable name.
 pub static GLOBAL_CALLDATA_SIZE: &str = "calldatasize";
 
+/// The heap size global variable name.
+pub static GLOBAL_HEAP_SIZE: &str = "__heap_size";
+
+/// The heap memory global variable name.
+pub static GLOBAL_HEAP_MEMORY: &str = "__heap_memory";
+
 /// The spill buffer global variable name.
 pub static GLOBAL_ADDRESS_SPILL_BUFFER: &str = "address_spill_buffer";
 

crates/llvm-context/src/polkavm/context/function/runtime/entry.rs

@@ -31,6 +31,23 @@ impl Entry {
             context.xlen_type().get_undef(),
         );
 
+        context.set_global(
+            crate::polkavm::GLOBAL_HEAP_SIZE,
+            context.xlen_type(),
+            AddressSpace::Stack,
+            context.xlen_type().const_zero(),
+        );
+
+        let heap_memory_type = context
+            .byte_type()
+            .array_type(context.memory_config.heap_size);
+        context.set_global(
+            crate::polkavm::GLOBAL_HEAP_MEMORY,
+            heap_memory_type,
+            AddressSpace::Stack,
+            heap_memory_type.const_zero(),
+        );
+
         let address_type = context.integer_type(revive_common::BIT_LENGTH_ETH_ADDRESS);
         context.set_global(
             crate::polkavm::GLOBAL_ADDRESS_SPILL_BUFFER,

crates/llvm-context/src/polkavm/context/function/runtime/mod.rs

@@ -5,6 +5,7 @@ pub mod deploy_code;
 pub mod entry;
 pub mod revive;
 pub mod runtime_code;
+pub mod sbrk;
 
 /// The main entry function name.
 pub const FUNCTION_ENTRY: &str = "__entry";

crates/llvm-context/src/polkavm/context/function/runtime/sbrk.rs

@@ -0,0 +1,144 @@
+//! Emulates the linear EVM heap memory via a simulated `sbrk` system call.
+
+use inkwell::values::BasicValue;
+
+use crate::polkavm::context::attribute::Attribute;
+use crate::polkavm::context::runtime::RuntimeFunction;
+use crate::polkavm::context::Context;
+use crate::polkavm::Dependency;
+use crate::polkavm::WriteLLVM;
+
+/// Simulates the `sbrk` system call, reproducing the semantics of the EVM heap memory.
+///
+/// Parameters:
+/// - The `offset` into the emulated EVM heap memory.
+/// - The `size` of the allocation emulated EVM heap memory.
+///
+/// Returns:
+/// - A pointer to the EVM heap memory at given `offset`.
+///
+/// Semantics:
+/// - Traps if the offset is out of bounds.
+/// - Aligns the total heap memory size to the EVM word size.
+/// - Traps if the memory size would be greater than the configured EVM heap memory size.
+/// - Maintains the total memory size (`msize`) in global heap size value.
+pub struct Sbrk;
+
+impl<D> RuntimeFunction<D> for Sbrk
+where
+    D: Dependency + Clone,
+{
+    const NAME: &'static str = "__sbrk_internal";
+
+    const ATTRIBUTES: &'static [Attribute] = &[
+        Attribute::NoFree,
+        Attribute::NoRecurse,
+        Attribute::WillReturn,
+    ];
+
+    fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
+        context.llvm().ptr_type(Default::default()).fn_type(
+            &[context.xlen_type().into(), context.xlen_type().into()],
+            false,
+        )
+    }
+
+    fn emit_body<'ctx>(
+        &self,
+        context: &mut Context<'ctx, D>,
+    ) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
+        let offset = Self::paramater(context, 0).into_int_value();
+        let size = Self::paramater(context, 1).into_int_value();
+
+        let trap_block = context.append_basic_block("trap");
+        let offset_in_bounds_block = context.append_basic_block("offset_in_bounds");
+        let is_offset_out_of_bounds = context.builder().build_int_compare(
+            inkwell::IntPredicate::UGE,
+            offset,
+            context.heap_size(),
+            "offset_out_of_bounds",
+        )?;
+        context.build_conditional_branch(
+            is_offset_out_of_bounds,
+            trap_block,
+            offset_in_bounds_block,
+        )?;
+
+        context.set_basic_block(trap_block);
+        context.build_call(context.intrinsics().trap, &[], "invalid_trap");
+        context.build_unreachable();
+
+        context.set_basic_block(offset_in_bounds_block);
+        let mask = context
+            .xlen_type()
+            .const_int(revive_common::BYTE_LENGTH_WORD as u64 - 1, false);
+        let total_size = context
+            .builder()
+            .build_int_add(offset, size, "total_size")?;
+        let memory_size = context.builder().build_and(
+            context.builder().build_int_add(total_size, mask, "mask")?,
+            context.builder().build_not(mask, "mask_not")?,
+            "memory_size",
+        )?;
+        let size_in_bounds_block = context.append_basic_block("size_in_bounds");
+        let is_size_out_of_bounds = context.builder().build_int_compare(
+            inkwell::IntPredicate::UGT,
+            memory_size,
+            context.heap_size(),
+            "size_out_of_bounds",
+        )?;
+        context.build_conditional_branch(
+            is_size_out_of_bounds,
+            trap_block,
+            size_in_bounds_block,
+        )?;
+
+        context.set_basic_block(size_in_bounds_block);
+        let return_block = context.append_basic_block("return_pointer");
+        let new_size_block = context.append_basic_block("new_size");
+        let is_new_size = context.builder().build_int_compare(
+            inkwell::IntPredicate::UGT,
+            memory_size,
+            context
+                .get_global_value(crate::polkavm::GLOBAL_HEAP_SIZE)?
+                .into_int_value(),
+            "is_new_size",
+        )?;
+        context.build_conditional_branch(is_new_size, new_size_block, return_block)?;
+
+        context.set_basic_block(new_size_block);
+        context.build_store(
+            context.get_global(crate::polkavm::GLOBAL_HEAP_SIZE)?.into(),
+            memory_size,
+        )?;
+        context.build_unconditional_branch(return_block);
+
+        context.set_basic_block(return_block);
+        Ok(Some(
+            context
+                .build_gep(
+                    context
+                        .get_global(crate::polkavm::GLOBAL_HEAP_MEMORY)?
+                        .into(),
+                    &[context.xlen_type().const_zero(), offset],
+                    context.byte_type(),
+                    "allocation_start_pointer",
+                )
+                .value
+                .as_basic_value_enum(),
+        ))
+    }
+}
+
+impl<D> WriteLLVM<D> for Sbrk
+where
+    D: Dependency + Clone,
+{
+    fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
+        <Self as RuntimeFunction<_>>::declare(self, context)
+    }
+
+    fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
+        <Self as RuntimeFunction<_>>::emit(&self, context)
+    }
+}

crates/llvm-context/src/polkavm/context/mod.rs

@@ -26,6 +26,7 @@ use inkwell::debug_info::DIScope;
 use inkwell::types::BasicType;
 use inkwell::values::BasicValue;
 
+use crate::memory::MemoryConfig;
 use crate::optimizer::settings::Settings as OptimizerSettings;
 use crate::optimizer::Optimizer;
 use crate::polkavm::DebugConfig;
@@ -33,6 +34,7 @@ use crate::polkavm::Dependency;
 use crate::target_machine::target::Target;
 use crate::target_machine::TargetMachine;
 use crate::PolkaVMLoadHeapWordFunction;
+use crate::PolkaVMSbrkFunction;
 use crate::PolkaVMStoreHeapWordFunction;
 
 use self::address_space::AddressSpace;
@@ -85,6 +87,8 @@ where
     loop_stack: Vec<Loop<'ctx>>,
     /// The extra LLVM arguments that were used during target initialization.
     llvm_arguments: &'ctx [String],
+    /// The PVM memory configuration.
+    memory_config: MemoryConfig,
 
     /// The project dependency manager. It can be any entity implementing the trait.
     /// The manager is used to get information about contracts and their dependencies during
@@ -116,9 +120,6 @@ where
     /// The loop stack default capacity.
     const LOOP_STACK_INITIAL_CAPACITY: usize = 16;
 
-    /// The PolkaVM minimum stack size.
-    const POLKAVM_STACK_SIZE: u32 = 0x4000;
-
     /// Link in the stdlib module.
     fn link_stdlib_module(
         llvm: &'ctx inkwell::context::Context,
@@ -218,6 +219,7 @@ where
     }
 
     /// Initializes a new LLVM context.
+    #[allow(clippy::too_many_arguments)]
     pub fn new(
         llvm: &'ctx inkwell::context::Context,
         module: inkwell::module::Module<'ctx>,
@@ -226,11 +228,12 @@ where
         include_metadata_hash: bool,
         debug_config: DebugConfig,
         llvm_arguments: &'ctx [String],
+        memory_config: MemoryConfig,
     ) -> Self {
         Self::set_data_layout(llvm, &module);
         Self::link_stdlib_module(llvm, &module);
         Self::link_polkavm_imports(llvm, &module);
-        Self::set_polkavm_stack_size(llvm, &module, Self::POLKAVM_STACK_SIZE);
+        Self::set_polkavm_stack_size(llvm, &module, memory_config.stack_size);
         Self::set_module_flags(llvm, &module);
 
         let intrinsics = Intrinsics::new(llvm, &module);
@@ -254,6 +257,7 @@ where
             current_function: None,
             loop_stack: Vec::with_capacity(Self::LOOP_STACK_INITIAL_CAPACITY),
             llvm_arguments,
+            memory_config,
 
             dependency_manager,
             include_metadata_hash,
@@ -644,6 +648,7 @@ where
                     self.include_metadata_hash,
                     self.debug_config.clone(),
                     self.llvm_arguments,
+                    self.memory_config,
                 )
             })
     }
@@ -1084,32 +1089,40 @@ where
         offset: inkwell::values::IntValue<'ctx>,
         size: inkwell::values::IntValue<'ctx>,
     ) -> anyhow::Result<inkwell::values::PointerValue<'ctx>> {
-        Ok(self
-            .builder()
-            .build_call(
-                self.runtime_api_method(revive_runtime_api::polkavm_imports::SBRK),
-                &[offset.into(), size.into()],
-                "call_sbrk",
-            )?
+        let call_site_value = self.builder().build_call(
+            <PolkaVMSbrkFunction as RuntimeFunction<D>>::declaration(self).function_value(),
+            &[offset.into(), size.into()],
+            "alloc_start",
+        )?;
+
+        call_site_value.add_attribute(
+            inkwell::attributes::AttributeLoc::Return,
+            self.llvm
+                .create_enum_attribute(Attribute::NonNull as u32, 0),
+        );
+        call_site_value.add_attribute(
+            inkwell::attributes::AttributeLoc::Return,
+            self.llvm
+                .create_enum_attribute(Attribute::NoUndef as u32, 0),
+        );
+
+        Ok(call_site_value
             .try_as_basic_value()
             .left()
-            .expect("sbrk returns a pointer")
+            .unwrap_or_else(|| {
+                panic!(
+                    "revive runtime function {} should return a value",
+                    <PolkaVMSbrkFunction as RuntimeFunction<D>>::NAME,
+                )
+            })
             .into_pointer_value())
     }
 
     /// Build a call to PolkaVM `msize` for querying the linear memory size.
     pub fn build_msize(&self) -> anyhow::Result<inkwell::values::IntValue<'ctx>> {
-        let memory_size_pointer = self
-            .module()
-            .get_global(revive_runtime_api::polkavm_imports::MEMORY_SIZE)
-            .expect("the memory size symbol should have been declared")
-            .as_pointer_value();
-        let memory_size_value = self.builder().build_load(
-            self.xlen_type(),
-            memory_size_pointer,
-            "memory_size_value",
-        )?;
-        Ok(memory_size_value.into_int_value())
+        Ok(self
+            .get_global_value(crate::polkavm::GLOBAL_HEAP_SIZE)?
+            .into_int_value())
     }
 
     /// Returns a pointer to `offset` into the heap, allocating
@@ -1428,4 +1441,9 @@ where
     pub fn optimizer_settings(&self) -> &OptimizerSettings {
         self.optimizer.settings()
     }
+
+    pub fn heap_size(&self) -> inkwell::values::IntValue<'ctx> {
+        self.xlen_type()
+            .const_int(self.memory_config.heap_size as u64, false)
+    }
 }

crates/llvm-context/src/polkavm/context/tests.rs

@@ -23,6 +23,7 @@ pub fn create_context(
         true,
         Default::default(),
         Default::default(),
+        Default::default(),
     )
 }
 

crates/llvm-context/src/polkavm/mod.rs

@@ -7,6 +7,7 @@ pub mod evm;
 pub use self::r#const::*;
 
 use crate::debug_config::DebugConfig;
+use crate::memory::MemoryConfig;
 use crate::optimizer::settings::Settings as OptimizerSettings;
 
 use anyhow::Context as AnyhowContext;
@@ -90,6 +91,7 @@ pub trait Dependency {
         include_metadata_hash: bool,
         debug_config: DebugConfig,
         llvm_arguments: &[String],
+        memory_config: MemoryConfig,
     ) -> anyhow::Result<String>;
 
     /// Resolves a full contract path.
@@ -111,6 +113,7 @@ impl Dependency for DummyDependency {
         _include_metadata_hash: bool,
         _debug_config: DebugConfig,
         _llvm_arguments: &[String],
+        _memory_config: MemoryConfig,
     ) -> anyhow::Result<String> {
         Ok(String::new())
     }

crates/runner/Cargo.toml

@@ -10,12 +10,19 @@ description = "Execute revive contracts in a simulated blockchain runtime"
 [package.metadata.cargo-machete]
 ignored = ["codec", "scale-info"]
 
+[[bin]]
+name = "revive-runner"
+path = "src/main.rs"
+
 [features]
 std = ["polkadot-sdk/std"]
 default = ["solidity"]
-solidity = ["revive-solidity", "revive-differential"]
+solidity = ["revive-solidity", "revive-differential", "revive-llvm-context"]
 
 [dependencies]
+env_logger = { workspace = true }
+clap = { workspace = true, features = ["help", "std", "derive"] }
+anyhow = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
 hex = { workspace = true, features = ["serde"] }
@@ -34,4 +41,4 @@ polkadot-sdk.features = [
 
 revive-solidity = { workspace = true, optional = true }
 revive-differential = { workspace = true, optional = true }
-revive-llvm-context = { workspace = true }
+revive-llvm-context = { workspace = true, optional = true }

crates/runner/README.md

@@ -0,0 +1,26 @@
+# revive-runner
+
+The revive runner is a helper utility aiding in contract debugging.
+
+Given a PVM contract blob, it will upload, deploy and call that contract using a local, stand-alone un-blockchained pallet revive (which is our execution layer).
+
+This is somewhat similar to the geth `evm` utility binary.
+
+## Installation
+
+The `revive-runner` does not depend on the compiler itself, hence installing this utility does not depend on LLVM, so no LLVM build is required.
+
+Inside the root `revive` repository directory, execute:
+
+```bash
+make install-revive-runner
+```
+
+Which will install the `revive-runner` using `cargo`. 
+
+## Usage
+
+Set the `RUST_LOG` environment varibale to the `trace` level to see the full PolkaVM execution trace. For example:
+
+```bash
+RUST_LOG=trace revive-runner -f mycontract.pvm -c a9059cbb000000000000000000000000f24ff3a9cf04c71dbc94d0b566f7a27b94566cac0000000000000000000000000000000000000000000000000000000000000000

crates/runner/src/main.rs

@@ -0,0 +1,93 @@
+use std::path::PathBuf;
+
+use clap::Parser;
+
+use revive_runner::{Code, OptionalHex, Specs, SpecsAction::*, TestAddress};
+
+/// Execute revive PolkaVM contracts locally.
+#[derive(Parser)]
+#[command(version, about, long_about = None)]
+struct Arguments {
+    /// The hex encoded calldata for the contract call.
+    #[arg(short, long)]
+    calldata: Option<String>,
+
+    /// The hex encoded calldata for the contract deployment.
+    #[arg(short, long)]
+    deploy_calldata: Option<String>,
+
+    /// The hex encoded contract code blob to instantiate and execute.
+    #[arg(short, long)]
+    blob: Option<String>,
+
+    /// The contract code to instantiate and execute.
+    #[arg(short, long)]
+    file: Option<PathBuf>,
+
+    /// The origin account used to initiate the deploy and call transactions.
+    #[arg(short, long)]
+    origin: Option<TestAddress>,
+
+    /// The value the call transaction is endowed with.
+    #[arg(short, long)]
+    value: Option<u128>,
+
+    /// The value the deploy transaction is endowed with.
+    #[arg(long)]
+    deploy_value: Option<u128>,
+}
+
+fn main() -> anyhow::Result<()> {
+    env_logger::init();
+
+    let arguments = Arguments::parse();
+
+    let code = match (arguments.blob, arguments.file) {
+        (Some(blob), None) => hex::decode(blob)
+            .map_err(|error| anyhow::anyhow!("expected hex encoded PVM blob: {error}"))?,
+        (None, Some(file)) => std::fs::read(&file).map_err(|error| {
+            anyhow::anyhow!("unable to read PVM file {}: {error}", file.display())
+        })?,
+        _ => anyhow::bail!("should either provide a PVM blob or a PVM file"),
+    };
+    let calldata = match arguments.calldata {
+        Some(calldata) => hex::decode(calldata)
+            .map_err(|error| anyhow::anyhow!("expected hex encoded calldata: {error}"))?,
+        None => vec![],
+    };
+    let deploy_calldata = match arguments.deploy_calldata {
+        Some(calldata) => hex::decode(calldata)
+            .map_err(|error| anyhow::anyhow!("expected hex encoded calldata: {error}"))?,
+        None => vec![],
+    };
+    let origin = arguments.origin.unwrap_or(TestAddress::Alice);
+
+    let actions = vec![
+        Instantiate {
+            origin: origin.clone(),
+            value: arguments.deploy_value.unwrap_or(0),
+            gas_limit: None,
+            storage_deposit_limit: None,
+            code: Code::Bytes(code),
+            data: deploy_calldata,
+            salt: OptionalHex::default(),
+        },
+        Call {
+            origin,
+            dest: TestAddress::Instantiated(0),
+            value: arguments.value.unwrap_or(0),
+            gas_limit: None,
+            storage_deposit_limit: None,
+            data: calldata,
+        },
+    ];
+
+    Specs {
+        actions,
+        differential: false,
+        ..Default::default()
+    }
+    .run();
+
+    Ok(())
+}

crates/runner/src/specs.rs

@@ -1,9 +1,11 @@
-use std::time::Instant;
+use std::{str::FromStr, time::Instant};
 
 use serde::{Deserialize, Serialize};
 
 use crate::*;
-use alloy_primitives::{keccak256, Address};
+use alloy_primitives::keccak256;
+#[cfg(feature = "revive-solidity")]
+use alloy_primitives::Address;
 #[cfg(feature = "revive-solidity")]
 use revive_differential::{Evm, EvmLog};
 #[cfg(feature = "revive-solidity")]
@@ -156,6 +158,39 @@ impl TestAddress {
     }
 }
 
+impl FromStr for TestAddress {
+    type Err = &'static str;
+
+    fn from_str(value: &str) -> Result<Self, Self::Err> {
+        value.try_into()
+    }
+}
+
+impl TryFrom<&str> for TestAddress {
+    type Error = &'static str;
+
+    fn try_from(value: &str) -> Result<Self, Self::Error> {
+        match value {
+            "alice" => Ok(Self::Alice),
+            "bob" => Ok(Self::Bob),
+            "charlie" => Ok(Self::Charlie),
+            value => {
+                if let Ok(value) = value.parse() {
+                    return Ok(Self::Instantiated(value));
+                }
+
+                if let Ok(value) = hex::decode(value) {
+                    if value.len() == 20 {
+                        return Ok(Self::AccountId(H160(value.try_into().unwrap())));
+                    }
+                }
+
+                Err("can not parse into test address")
+            }
+        }
+    }
+}
+
 /// Specs for a contract test
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[serde(default)]
@@ -212,6 +247,7 @@ impl Specs {
     /// Helper to allow not specifying the code bytes or path directly in the runner.json
     /// - Replace `Code::Bytes(bytes)` if `bytes` are empty: read `contract_file`
     /// - Replace `Code::Solidity{ path, ..}` if `path` is not provided: replace `path` with `contract_file`
+    #[allow(unused_variables)]
     pub fn replace_empty_code(&mut self, contract_name: &str, contract_path: &str) {
         for action in self.actions.iter_mut() {
             let code = match action {

crates/runtime-api/src/polkavm_imports.c

@@ -5,34 +5,6 @@
 
 // Missing builtins
 
-#define EVM_WORD_SIZE 32
-#define ALIGN(size) ((size + EVM_WORD_SIZE - 1) & ~(EVM_WORD_SIZE - 1))
-#define MAX_MEMORY_SIZE (64 * 1024)
-char __memory[MAX_MEMORY_SIZE];
-uint32_t __memory_size = 0;
-
-void * __sbrk_internal(uint32_t offset, uint32_t size) {
-    if (offset >= MAX_MEMORY_SIZE || size > MAX_MEMORY_SIZE) {
-        POLKAVM_TRAP();
-    }
-
-    uint32_t new_size = ALIGN(offset + size);
-    if (new_size > MAX_MEMORY_SIZE) {
-        POLKAVM_TRAP();
-    }
-    if (new_size > __memory_size) {
-        __memory_size = new_size;
-    }
-
-    return (void *)&__memory[offset];
-}
-
-void * memset(void *b, int c, size_t len) {
-    uint8_t *dest = b;
-    while (len-- > 0) *dest++ = c;
-    return b;
-}
-
 void * memcpy(void *dst, const void *_src, size_t len) {
     uint8_t *dest = dst;
     const uint8_t *src = _src;

crates/runtime-api/src/polkavm_imports.rs

@@ -2,14 +2,6 @@ use inkwell::{context::Context, memory_buffer::MemoryBuffer, module::Module, sup
 
 include!(concat!(env!("OUT_DIR"), "/polkavm_imports.rs"));
 
-/// The emulated EVM heap memory global symbol.
-pub static MEMORY: &str = "__memory";
-
-/// The emulated EVM heap memory size global symbol.
-pub static MEMORY_SIZE: &str = "__memory_size";
-
-pub static SBRK: &str = "__sbrk_internal";
-
 pub static ADDRESS: &str = "address";
 
 pub static BALANCE: &str = "balance";
@@ -78,8 +70,7 @@ pub static WEIGHT_TO_FEE: &str = "weight_to_fee";
 
 /// All imported runtime API symbols.
 /// Useful for configuring common attributes and linkage.
-pub static IMPORTS: [&str; 34] = [
-    SBRK,
+pub static IMPORTS: [&str; 33] = [
     ADDRESS,
     BALANCE,
     BALANCE_OF,

crates/solidity/src/lib.rs

@@ -55,6 +55,7 @@ pub fn yul<T: Compiler>(
     include_metadata_hash: bool,
     debug_config: revive_llvm_context::DebugConfig,
     llvm_arguments: &[String],
+    memory_config: revive_llvm_context::MemoryConfig,
 ) -> anyhow::Result<Build> {
     let path = match input_files.len() {
         1 => input_files.first().expect("Always exists"),
@@ -80,6 +81,7 @@ pub fn yul<T: Compiler>(
         include_metadata_hash,
         debug_config,
         llvm_arguments,
+        memory_config,
     )?;
 
     Ok(build)
@@ -92,6 +94,7 @@ pub fn llvm_ir(
     include_metadata_hash: bool,
     debug_config: revive_llvm_context::DebugConfig,
     llvm_arguments: &[String],
+    memory_config: revive_llvm_context::MemoryConfig,
 ) -> anyhow::Result<Build> {
     let path = match input_files.len() {
         1 => input_files.first().expect("Always exists"),
@@ -109,6 +112,7 @@ pub fn llvm_ir(
         include_metadata_hash,
         debug_config,
         llvm_arguments,
+        memory_config,
     )?;
 
     Ok(build)
@@ -131,6 +135,7 @@ pub fn standard_output<T: Compiler>(
     suppressed_warnings: Option<Vec<ResolcWarning>>,
     debug_config: revive_llvm_context::DebugConfig,
     llvm_arguments: &[String],
+    memory_config: revive_llvm_context::MemoryConfig,
 ) -> anyhow::Result<Build> {
     let solc_version = solc.version()?;
 
@@ -189,12 +194,14 @@ pub fn standard_output<T: Compiler>(
         include_metadata_hash,
         debug_config,
         llvm_arguments,
+        memory_config,
     )?;
 
     Ok(build)
 }
 
 /// Runs the standard JSON mode.
+#[allow(clippy::too_many_arguments)]
 pub fn standard_json<T: Compiler>(
     solc: &mut T,
     detect_missing_libraries: bool,
@@ -203,6 +210,7 @@ pub fn standard_json<T: Compiler>(
     allow_paths: Option<String>,
     debug_config: revive_llvm_context::DebugConfig,
     llvm_arguments: &[String],
+    memory_config: revive_llvm_context::MemoryConfig,
 ) -> anyhow::Result<()> {
     let solc_version = solc.version()?;
 
@@ -250,6 +258,7 @@ pub fn standard_json<T: Compiler>(
             include_metadata_hash,
             debug_config,
             llvm_arguments,
+            memory_config,
         )?;
         build.write_to_standard_json(&mut solc_output, &solc_version)?;
     }
@@ -277,6 +286,7 @@ pub fn combined_json<T: Compiler>(
     output_directory: Option<PathBuf>,
     overwrite: bool,
     llvm_arguments: &[String],
+    memory_config: revive_llvm_context::MemoryConfig,
 ) -> anyhow::Result<()> {
     let build = standard_output(
         input_files,
@@ -293,6 +303,7 @@ pub fn combined_json<T: Compiler>(
         suppressed_warnings,
         debug_config,
         llvm_arguments,
+        memory_config,
     )?;
 
     let mut combined_json = solc.combined_json(input_files, format.as_str())?;

crates/solidity/src/process/input.rs

@@ -22,6 +22,8 @@ pub struct Input {
     pub debug_config: revive_llvm_context::DebugConfig,
     /// The extra LLVM arguments give used for manual control.
     pub llvm_arguments: Vec<String>,
+    /// The PVM memory configuration.
+    pub memory_config: revive_llvm_context::MemoryConfig,
 }
 
 impl Input {
@@ -33,6 +35,7 @@ impl Input {
         optimizer_settings: revive_llvm_context::OptimizerSettings,
         debug_config: revive_llvm_context::DebugConfig,
         llvm_arguments: Vec<String>,
+        memory_config: revive_llvm_context::MemoryConfig,
     ) -> Self {
         Self {
             contract,
@@ -41,6 +44,7 @@ impl Input {
             optimizer_settings,
             debug_config,
             llvm_arguments,
+            memory_config,
         }
     }
 }

crates/solidity/src/process/mod.rs

@@ -50,6 +50,7 @@ pub trait Process {
             input.include_metadata_hash,
             input.debug_config,
             &input.llvm_arguments,
+            input.memory_config,
         );
 
         match result {

crates/solidity/src/project/contract/mod.rs

@@ -78,6 +78,7 @@ impl Contract {
         include_metadata_hash: bool,
         debug_config: revive_llvm_context::DebugConfig,
         llvm_arguments: &[String],
+        memory_config: revive_llvm_context::MemoryConfig,
     ) -> anyhow::Result<ContractBuild> {
         let llvm = inkwell::context::Context::create();
         let optimizer = revive_llvm_context::Optimizer::new(optimizer_settings);
@@ -123,6 +124,7 @@ impl Contract {
             include_metadata_hash,
             debug_config,
             llvm_arguments,
+            memory_config,
         );
         context.set_solidity_data(revive_llvm_context::PolkaVMContextSolidityData::default());
         match self.ir {

crates/solidity/src/project/mod.rs

@@ -67,6 +67,7 @@ impl Project {
         include_metadata_hash: bool,
         debug_config: revive_llvm_context::DebugConfig,
         llvm_arguments: &[String],
+        memory_config: revive_llvm_context::MemoryConfig,
     ) -> anyhow::Result<Build> {
         let project = self.clone();
         #[cfg(feature = "parallel")]
@@ -83,6 +84,7 @@ impl Project {
                     optimizer_settings.clone(),
                     debug_config.clone(),
                     llvm_arguments.to_vec(),
+                    memory_config,
                 );
                 let process_output = {
                     #[cfg(target_os = "emscripten")]
@@ -319,6 +321,7 @@ impl revive_llvm_context::PolkaVMDependency for Project {
         include_metadata_hash: bool,
         debug_config: revive_llvm_context::DebugConfig,
         llvm_arguments: &[String],
+        memory_config: revive_llvm_context::MemoryConfig,
     ) -> anyhow::Result<String> {
         let contract_path = project.resolve_path(identifier)?;
         let contract = project
@@ -339,6 +342,7 @@ impl revive_llvm_context::PolkaVMDependency for Project {
                 include_metadata_hash,
                 debug_config,
                 llvm_arguments,
+                memory_config,
             )
             .map_err(|error| {
                 anyhow::anyhow!(

crates/solidity/src/resolc/arguments.rs

@@ -167,9 +167,41 @@ pub struct Arguments {
     #[arg(long = "recursive-process-input")]
     pub recursive_process_input: Option<String>,
 
-    #[arg(long = "llvm-arg")]
     /// These are passed to LLVM as the command line to allow manual control.
+    #[arg(long = "llvm-arg")]
     pub llvm_arguments: Vec<String>,
+
+    /// The emulated EVM linear heap memory static buffer size in bytes.
+    ///
+    /// Unlike the EVM, due to the lack of dynamic memory metering, PVM contracts emulate
+    /// the EVM heap memory with a static buffer. Consequentially, instead of infinite
+    /// memory with exponentially growing gas costs, PVM contracts have a finite amount
+    /// of memory with constant gas costs available.
+    ///
+    /// If the contract uses more heap memory than configured, it will compile fine but
+    /// eventually revert execution at runtime!
+    ///
+    /// You are incentiviced to keep this value as small as possible:
+    /// 1.Increasing the heap size will increase startup costs.
+    /// 2.The heap size contributes to the total memory size a contract can use,
+    ///   which includes the contracts code size
+    #[arg(long = "heap-size", default_value = "65536")]
+    pub heap_size: u32,
+
+    /// The contracts total stack size in bytes.
+    ///
+    /// PVM is a register machine with a traditional stack memory space for local
+    /// variables. This controls the total amount of stack space the contract can use.
+    ///
+    /// If the contract uses more stack memory than configured, it will compile fine but
+    /// eventually revert execution at runtime!
+    ///
+    /// You are incentiviced to keep this value as small as possible:
+    /// 1.Increasing the heap size will increase startup costs.
+    /// 2.The stack size contributes to the total memory size a contract can use,
+    ///   which includes the contracts code size
+    #[arg(long = "stack-size", default_value = "32768")]
+    pub stack_size: u32,
 }
 
 impl Arguments {

crates/solidity/src/resolc/main.rs

@@ -148,6 +148,11 @@ fn main_inner() -> anyhow::Result<()> {
         None => true,
     };
 
+    let memory_config = revive_llvm_context::MemoryConfig {
+        heap_size: arguments.heap_size,
+        stack_size: arguments.stack_size,
+    };
+
     let build = if arguments.yul {
         revive_solidity::yul(
             input_files.as_slice(),
@@ -156,6 +161,7 @@ fn main_inner() -> anyhow::Result<()> {
             include_metadata_hash,
             debug_config,
             &arguments.llvm_arguments,
+            memory_config,
         )
     } else if arguments.llvm_ir {
         revive_solidity::llvm_ir(
@@ -164,6 +170,7 @@ fn main_inner() -> anyhow::Result<()> {
             include_metadata_hash,
             debug_config,
             &arguments.llvm_arguments,
+            memory_config,
         )
     } else if arguments.standard_json {
         revive_solidity::standard_json(
@@ -174,6 +181,7 @@ fn main_inner() -> anyhow::Result<()> {
             arguments.allow_paths,
             debug_config,
             &arguments.llvm_arguments,
+            memory_config,
         )?;
         return Ok(());
     } else if let Some(format) = arguments.combined_json {
@@ -195,6 +203,7 @@ fn main_inner() -> anyhow::Result<()> {
             arguments.output_directory,
             arguments.overwrite,
             &arguments.llvm_arguments,
+            memory_config,
         )?;
         return Ok(());
     } else {
@@ -213,6 +222,7 @@ fn main_inner() -> anyhow::Result<()> {
             suppressed_warnings,
             debug_config,
             &arguments.llvm_arguments,
+            memory_config,
         )
     }?;
 

crates/solidity/src/test_utils.rs

@@ -115,8 +115,13 @@ pub fn build_solidity_with_options(
         &debug_config,
     )?;
 
-    let build: crate::Build =
-        project.compile(optimizer_settings, false, debug_config, Default::default())?;
+    let build: crate::Build = project.compile(
+        optimizer_settings,
+        false,
+        debug_config,
+        Default::default(),
+        Default::default(),
+    )?;
     build.write_to_standard_json(&mut output, &solc_version)?;
 
     Ok(output)
@@ -243,7 +248,13 @@ pub fn build_yul(source_code: &str) -> anyhow::Result<()> {
         source_code,
         None,
     )?;
-    let _build = project.compile(optimizer_settings, false, DEBUG_CONFIG, Default::default())?;
+    let _build = project.compile(
+        optimizer_settings,
+        false,
+        DEBUG_CONFIG,
+        Default::default(),
+        Default::default(),
+    )?;
 
     Ok(())
 }

crates/solidity/src/yul/parser/statement/object.rs

@@ -209,6 +209,8 @@ where
         revive_llvm_context::PolkaVMRemainderFunction.declare(context)?;
         revive_llvm_context::PolkaVMSignedRemainderFunction.declare(context)?;
 
+        revive_llvm_context::PolkaVMSbrkFunction.declare(context)?;
+
         let mut entry = revive_llvm_context::PolkaVMEntryFunction::default();
         entry.declare(context)?;
 
@@ -261,6 +263,8 @@ where
         revive_llvm_context::PolkaVMRemainderFunction.into_llvm(context)?;
         revive_llvm_context::PolkaVMSignedRemainderFunction.into_llvm(context)?;
 
+        revive_llvm_context::PolkaVMSbrkFunction.into_llvm(context)?;
+
         Ok(())
     }