From c47adc1bd4831d0ded404a8d1f7ebfd5cd05193e Mon Sep 17 00:00:00 2001 From: holygits Date: Wed, 23 Jan 2019 17:03:53 +1300 Subject: [PATCH] Refactor TargetRuntime as enum Don't rename create symbol for substrate binaries --- cli/pack/main.rs | 2 +- cli/prune/main.rs | 4 +-- src/build.rs | 6 ++-- src/lib.rs | 77 +++++++++++++++++++++++++++++------------------ src/pack.rs | 38 ++++++++++++----------- 5 files changed, 74 insertions(+), 53 deletions(-) diff --git a/cli/pack/main.rs b/cli/pack/main.rs index 41703d7..5a0b98c 100644 --- a/cli/pack/main.rs +++ b/cli/pack/main.rs @@ -31,7 +31,7 @@ fn main() { // Invoke packer let mut result_module = utils::pack_instance(raw_module, ctor_module, &utils::TargetRuntime::pwasm()).expect("Packing failed"); // Optimize constructor, since it does not need everything - utils::optimize(&mut result_module, vec![target_runtime.call_symbol]).expect("Optimization failed"); + utils::optimize(&mut result_module, vec![target_runtime.symbols().call]).expect("Optimization failed"); parity_wasm::serialize_to_file(&output, result_module).expect("Serialization failed"); } diff --git a/cli/prune/main.rs b/cli/prune/main.rs index 348f28e..e44fa79 100644 --- a/cli/prune/main.rs +++ b/cli/prune/main.rs @@ -24,12 +24,12 @@ fn main() { .short("e") .takes_value(true) .value_name("functions") - .help(&format!("Comma-separated list of exported functions to keep. Default: '{}'", target_runtime.call_symbol))) + .help(&format!("Comma-separated list of exported functions to keep. Default: '{}'", target_runtime.symbols().call))) .get_matches(); let exports = matches .value_of("exports") - .unwrap_or(target_runtime.call_symbol) + .unwrap_or(target_runtime.symbols().call) .split(',') .collect(); diff --git a/src/build.rs b/src/build.rs index bd55490..267183d 100644 --- a/src/build.rs +++ b/src/build.rs @@ -51,7 +51,7 @@ impl std::fmt::Display for Error { fn has_ctor(module: &elements::Module, target_runtime: &TargetRuntime) -> bool { if let Some(ref section) = module.export_section() { - section.entries().iter().any(|e| target_runtime.create_symbol == e.field()) + section.entries().iter().any(|e| target_runtime.symbols().create == e.field()) } else { false } @@ -94,7 +94,7 @@ pub fn build( let mut ctor_module = module.clone(); let mut public_api_entries = public_api_entries.to_vec(); - public_api_entries.push(target_runtime.call_symbol); + public_api_entries.push(target_runtime.symbols().call); if !skip_optimization { optimize( &mut module, @@ -104,7 +104,7 @@ pub fn build( if has_ctor(&ctor_module, target_runtime) { if !skip_optimization { - optimize(&mut ctor_module, vec![target_runtime.create_symbol])?; + optimize(&mut ctor_module, vec![target_runtime.symbols().create])?; } let ctor_module = pack_instance( parity_wasm::serialize(module.clone()).map_err(Error::Encoding)?, diff --git a/src/lib.rs b/src/lib.rs index 3d1c546..97bfe3e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -5,59 +5,76 @@ #[macro_use] extern crate alloc; -extern crate parity_wasm; extern crate byteorder; -#[macro_use] extern crate log; +extern crate parity_wasm; +#[macro_use] +extern crate log; pub mod rules; mod build; -mod optimizer; -mod gas; -mod symbols; mod ext; +mod gas; +mod optimizer; mod pack; mod runtime_type; +mod symbols; pub mod stack_height; -pub use build::{build, SourceTarget, Error as BuildError}; -pub use optimizer::{optimize, Error as OptimizerError}; +pub use build::{build, Error as BuildError, SourceTarget}; +pub use ext::{ + externalize, externalize_mem, shrink_unknown_stack, underscore_funcs, ununderscore_funcs, +}; pub use gas::inject_gas_counter; -pub use ext::{externalize, externalize_mem, underscore_funcs, ununderscore_funcs, shrink_unknown_stack}; +pub use optimizer::{optimize, Error as OptimizerError}; pub use pack::{pack_instance, Error as PackingError}; pub use runtime_type::inject_runtime_type; -pub struct TargetRuntime { - pub create_symbol: &'static str, - pub call_symbol: &'static str, - pub return_symbol: &'static str, +pub struct TargetSymbols { + pub create: &'static str, + pub call: &'static str, + pub return_: &'static str, +} + +pub enum TargetRuntime { + Substrate(TargetSymbols), + PWasm(TargetSymbols), } impl TargetRuntime { - pub fn substrate() -> TargetRuntime { - TargetRuntime { - create_symbol: "deploy", - call_symbol: "call", - return_symbol: "ext_return", - } - } - pub fn pwasm() -> TargetRuntime { - TargetRuntime { - create_symbol: "deploy", - call_symbol: "call", - return_symbol: "ret", + pub fn substrate() -> TargetRuntime { + TargetRuntime::Substrate(TargetSymbols { + create: "deploy", + call: "call", + return_: "ext_return", + }) + } + + pub fn pwasm() -> TargetRuntime { + TargetRuntime::PWasm(TargetSymbols { + create: "deploy", + call: "call", + return_: "ret", + }) + } + + pub fn symbols(&self) -> &TargetSymbols { + match self { + TargetRuntime::Substrate(s) => s, + TargetRuntime::PWasm(s) => s, } - } + } + } #[cfg(not(feature = "std"))] mod std { - pub use core::*; - pub use alloc::{vec, string, boxed, borrow}; + pub use alloc::{borrow, boxed, string, vec}; + pub use core::*; - pub mod collections { - pub use alloc::collections::{BTreeMap, BTreeSet}; - } + pub mod collections { + pub use alloc::collections::{BTreeMap, BTreeSet}; + } } diff --git a/src/pack.rs b/src/pack.rs index cdcc5c9..f318925 100644 --- a/src/pack.rs +++ b/src/pack.rs @@ -41,7 +41,7 @@ impl fmt::Display for Error { } } -/// If module has an exported "CREATE_SYMBOL" function we want to pack it into "constructor". +/// If module has an exported function matching "create" symbol we want to pack it into "constructor". /// `raw_module` is the actual contract code /// `ctor_module` is the constructor which should return `raw_module` pub fn pack_instance(raw_module: Vec, mut ctor_module: elements::Module, target: &TargetRuntime) -> Result { @@ -49,15 +49,15 @@ pub fn pack_instance(raw_module: Vec, mut ctor_module: elements::Module, tar // Total number of constructor module import functions let ctor_import_functions = ctor_module.import_section().map(|x| x.functions()).unwrap_or(0); - // We need to find an internal ID of function witch is exported as "CREATE_SYMBOL" + // We need to find an internal ID of function which is exported as `symbols().create` // in order to find it in the Code section of the module let mut create_func_id = { let found_entry = ctor_module.export_section().ok_or(Error::NoExportSection)?.entries().iter() - .find(|entry| target.create_symbol == entry.field()).ok_or_else(|| Error::NoCreateSymbol(target.create_symbol))?; + .find(|entry| target.symbols().create == entry.field()).ok_or_else(|| Error::NoCreateSymbol(target.symbols().create))?; let function_index: usize = match found_entry.internal() { &Internal::Function(index) => index as usize, - _ => { return Err(Error::InvalidCreateMember(target.create_symbol)) }, + _ => { return Err(Error::InvalidCreateMember(target.symbols().create)) }, }; // Calculates a function index within module's function section @@ -73,10 +73,10 @@ pub fn pack_instance(raw_module: Vec, mut ctor_module: elements::Module, tar // Deploy should have no arguments and also should return nothing if !func.params().is_empty() { - return Err(Error::InvalidCreateSignature(target.create_symbol)); + return Err(Error::InvalidCreateSignature(target.symbols().create)); } if func.return_type().is_some() { - return Err(Error::InvalidCreateSignature(target.create_symbol)); + return Err(Error::InvalidCreateSignature(target.symbols().create)); } function_internal_index @@ -87,7 +87,7 @@ pub fn pack_instance(raw_module: Vec, mut ctor_module: elements::Module, tar let mut found = false; for entry in ctor_module.import_section().ok_or(Error::NoImportSection)?.entries().iter() { if let External::Function(_) = *entry.external() { - if entry.field() == target.return_symbol { found = true; break; } + if entry.field() == target.symbols().return_ { found = true; break; } else { id += 1; } } } @@ -102,7 +102,7 @@ pub fn pack_instance(raw_module: Vec, mut ctor_module: elements::Module, tar mbuilder.push_import( builder::import() .module("env") - .field(&target.return_symbol) + .field(&target.symbols().return_) .external().func(import_sig) .build() ); @@ -195,13 +195,17 @@ pub fn pack_instance(raw_module: Vec, mut ctor_module: elements::Module, tar ])).build() .build() .build(); + + if let TargetRuntime::Substrate(_) = target { + return Ok(new_module) + } for section in new_module.sections_mut() { if let &mut Section::Export(ref mut export_section) = section { for entry in export_section.entries_mut().iter_mut() { - if target.create_symbol == entry.field() { - // change `create_symbol` export name into default `call_symbol`. - *entry.field_mut() = target.call_symbol.to_owned(); + if target.symbols().create == entry.field() { + // change `create` symbol export name into default `call` symbol name. + *entry.field_mut() = target.symbols().call.to_owned(); *entry.internal_mut() = elements::Internal::Function(last_function_index as u32); } } @@ -221,8 +225,8 @@ mod test { fn test_packer(mut module: elements::Module, target_runtime: &TargetRuntime) { let mut ctor_module = module.clone(); - optimize(&mut module, vec![target_runtime.call_symbol]).expect("Optimizer to finish without errors"); - optimize(&mut ctor_module, vec![target_runtime.create_symbol]).expect("Optimizer to finish without errors"); + optimize(&mut module, vec![target_runtime.symbols().call]).expect("Optimizer to finish without errors"); + optimize(&mut ctor_module, vec![target_runtime.symbols().create]).expect("Optimizer to finish without errors"); let raw_module = parity_wasm::serialize(module).unwrap(); let ctor_module = pack_instance(raw_module.clone(), ctor_module, target_runtime).expect("Packing failed"); @@ -269,11 +273,11 @@ mod test { .build() .build() .export() - .field(target_runtime.call_symbol) + .field(target_runtime.symbols().call) .internal().func(1) .build() .export() - .field(target_runtime.create_symbol) + .field(target_runtime.symbols().create) .internal().func(2) .build() .build(), @@ -321,11 +325,11 @@ mod test { .build() .build() .export() - .field(target_runtime.call_symbol) + .field(target_runtime.symbols().call) .internal().func(1) .build() .export() - .field(target_runtime.create_symbol) + .field(target_runtime.symbols().create) .internal().func(2) .build() .build(),