expose custom PVM settings in the standard json interface (#318)

Exposes the following PolkaVM specific options via the standard json
interface:
- Heap size
- Stack size
- Whether to emit source level debug information

Additionally it is now forbidden to specify those as CLI option in
standard JSON mode. They are bytecode altering options and having
multiple ways to specify them creates unnecessary room for confusion:
The standard JSON input description should be sufficient and succint for
reproducible builds.

Closes #290

---------

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

crates/solidity/src/lib.rs

@@ -45,6 +45,8 @@ use revive_solc_json_interface::ResolcWarning;
 use revive_solc_json_interface::SolcStandardJsonInput;
 use revive_solc_json_interface::SolcStandardJsonInputLanguage;
 use revive_solc_json_interface::SolcStandardJsonInputSettingsOptimizer;
+use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVM;
+use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
 use revive_solc_json_interface::SolcStandardJsonInputSettingsSelection;
 
 /// Runs the Yul mode.
@@ -55,7 +57,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,
+    memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
 ) -> anyhow::Result<Build> {
     let path = match input_files.len() {
         1 => input_files.first().expect("Always exists"),
@@ -94,7 +96,7 @@ pub fn llvm_ir(
     include_metadata_hash: bool,
     debug_config: revive_llvm_context::DebugConfig,
     llvm_arguments: &[String],
-    memory_config: revive_llvm_context::MemoryConfig,
+    memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
 ) -> anyhow::Result<Build> {
     let path = match input_files.len() {
         1 => input_files.first().expect("Always exists"),
@@ -135,7 +137,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,
+    memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
 ) -> anyhow::Result<Build> {
     let solc_version = solc.version()?;
 
@@ -154,6 +156,10 @@ pub fn standard_output<T: Compiler>(
         ),
         None,
         suppressed_warnings,
+        Some(SolcStandardJsonInputSettingsPolkaVM::new(
+            Some(memory_config),
+            debug_config.emit_debug_info,
+        )),
     )?;
 
     let source_code_files = solc_input
@@ -208,9 +214,8 @@ pub fn standard_json<T: Compiler>(
     base_path: Option<String>,
     include_paths: Vec<String>,
     allow_paths: Option<String>,
-    debug_config: revive_llvm_context::DebugConfig,
+    mut debug_config: revive_llvm_context::DebugConfig,
     llvm_arguments: &[String],
-    memory_config: revive_llvm_context::MemoryConfig,
 ) -> anyhow::Result<()> {
     let solc_version = solc.version()?;
 
@@ -224,6 +229,9 @@ pub fn standard_json<T: Compiler>(
     let optimizer_settings =
         revive_llvm_context::OptimizerSettings::try_from(&solc_input.settings.optimizer)?;
 
+    let polkavm_settings = solc_input.settings.polkavm.unwrap_or_default();
+    debug_config.emit_debug_info = polkavm_settings.debug_information;
+
     let include_metadata_hash = match solc_input.settings.metadata {
         Some(ref metadata) => metadata.bytecode_hash != Some(MetadataHash::None),
         None => true,
@@ -258,7 +266,7 @@ pub fn standard_json<T: Compiler>(
             include_metadata_hash,
             debug_config,
             llvm_arguments,
-            memory_config,
+            polkavm_settings.memory_config,
         )?;
         build.write_to_standard_json(&mut solc_output, &solc_version)?;
     }
@@ -286,7 +294,7 @@ pub fn combined_json<T: Compiler>(
     output_directory: Option<PathBuf>,
     overwrite: bool,
     llvm_arguments: &[String],
-    memory_config: revive_llvm_context::MemoryConfig,
+    memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
 ) -> anyhow::Result<()> {
     let build = standard_output(
         input_files,

crates/solidity/src/process/input.rs

@@ -1,6 +1,7 @@
 //! Process for compiling a single compilation unit.
 //! The input data.
 
+use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
 use serde::Deserialize;
 use serde::Serialize;
 
@@ -23,7 +24,7 @@ pub struct Input {
     /// 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,
+    pub memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
 }
 
 impl Input {
@@ -35,7 +36,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,
+        memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
     ) -> Self {
         Self {
             contract,

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

@@ -5,6 +5,7 @@ pub mod metadata;
 
 use std::collections::HashSet;
 
+use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
 use serde::Deserialize;
 use serde::Serialize;
 use sha3::Digest;
@@ -78,7 +79,7 @@ impl Contract {
         include_metadata_hash: bool,
         debug_config: revive_llvm_context::DebugConfig,
         llvm_arguments: &[String],
-        memory_config: revive_llvm_context::MemoryConfig,
+        memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
     ) -> anyhow::Result<ContractBuild> {
         let llvm = inkwell::context::Context::create();
         let optimizer = revive_llvm_context::Optimizer::new(optimizer_settings);

crates/solidity/src/project/mod.rs

@@ -67,7 +67,7 @@ impl Project {
         include_metadata_hash: bool,
         debug_config: revive_llvm_context::DebugConfig,
         llvm_arguments: &[String],
-        memory_config: revive_llvm_context::MemoryConfig,
+        memory_config: revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory,
     ) -> anyhow::Result<Build> {
         let project = self.clone();
         #[cfg(feature = "parallel")]
@@ -321,7 +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,
+        memory_config: revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory,
     ) -> anyhow::Result<String> {
         let contract_path = project.resolve_path(identifier)?;
         let contract = project

crates/solidity/src/resolc/arguments.rs

@@ -185,8 +185,8 @@ pub struct Arguments {
     /// 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,
+    #[arg(long = "heap-size")]
+    pub heap_size: Option<u32>,
 
     /// The contracts total stack size in bytes.
     ///
@@ -200,8 +200,8 @@ pub struct Arguments {
     /// 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,
+    #[arg(long = "stack-size")]
+    pub stack_size: Option<u32>,
 }
 
 impl Arguments {
@@ -330,6 +330,22 @@ impl Arguments {
             if self.metadata_hash.is_some() {
                 anyhow::bail!("Metadata hash mode must specified in standard JSON input settings.");
             }
+
+            if self.heap_size.is_some() {
+                anyhow::bail!(
+                    "Heap size must be specified in standard JSON input polkavm memory settings."
+                );
+            }
+            if self.stack_size.is_some() {
+                anyhow::bail!(
+                    "Stack size must be specified in standard JSON input polkavm memory settings."
+                );
+            }
+            if self.emit_source_debug_info {
+                anyhow::bail!(
+                    "Debug info must be requested in standard JSON input polkavm settings."
+                );
+            }
         }
 
         Ok(())

crates/solidity/src/resolc/main.rs

@@ -148,10 +148,14 @@ 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 mut memory_config =
+        revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory::default();
+    if let Some(heap_size) = arguments.heap_size {
+        memory_config.heap_size = heap_size
+    }
+    if let Some(stack_size) = arguments.stack_size {
+        memory_config.stack_size = stack_size
+    }
 
     let build = if arguments.yul {
         revive_solidity::yul(
@@ -181,7 +185,6 @@ 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 {

crates/solidity/src/test_utils.rs

@@ -98,6 +98,7 @@ pub fn build_solidity_with_options(
         ),
         None,
         None,
+        None,
     )?;
 
     let mut output = solc.standard_json(input, None, vec![], None)?;
@@ -162,6 +163,7 @@ pub fn build_solidity_with_options_evm(
         ),
         None,
         None,
+        None,
     )?;
 
     let mut output = solc.standard_json(input, None, vec![], None)?;
@@ -213,6 +215,7 @@ pub fn build_solidity_and_detect_missing_libraries(
         SolcStandardJsonInputSettingsOptimizer::new(true, None, &solc_version.default, false),
         None,
         None,
+        None,
     )?;
 
     let mut output = solc.standard_json(input, None, vec![], None)?;
@@ -286,6 +289,7 @@ pub fn check_solidity_warning(
         SolcStandardJsonInputSettingsOptimizer::new(true, None, &solc_version.default, false),
         None,
         suppressed_warnings,
+        None,
     )?;
 
     let output = solc.standard_json(input, None, vec![], None)?;