configurable stack and heap memory size (#288)

- Allow configuration of the maximum heap and stack size via CLI flags
and JSON input settings.
- Increase the default value for the stack size to 32kb.

---------

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

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;
@@ -61,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;
@@ -76,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/context/function/runtime/entry.rs

@@ -38,7 +38,9 @@ impl Entry {
             context.xlen_type().const_zero(),
         );
 
-        let heap_memory_type = context.byte_type().array_type(context.heap_size);
+        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,

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;
@@ -86,8 +87,8 @@ where
     loop_stack: Vec<Loop<'ctx>>,
     /// The extra LLVM arguments that were used during target initialization.
     llvm_arguments: &'ctx [String],
-    /// The emulated EVM linear heap memory size.
-    heap_size: u32,
+    /// 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
@@ -119,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,
@@ -221,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>,
@@ -229,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);
@@ -257,7 +257,7 @@ where
             current_function: None,
             loop_stack: Vec::with_capacity(Self::LOOP_STACK_INITIAL_CAPACITY),
             llvm_arguments,
-            heap_size: 65536,
+            memory_config,
 
             dependency_manager,
             include_metadata_hash,
@@ -648,6 +648,7 @@ where
                     self.include_metadata_hash,
                     self.debug_config.clone(),
                     self.llvm_arguments,
+                    self.memory_config,
                 )
             })
     }
@@ -1442,6 +1443,7 @@ where
     }
 
     pub fn heap_size(&self) -> inkwell::values::IntValue<'ctx> {
-        self.xlen_type().const_int(self.heap_size as u64, false)
+        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())
     }