This repository was archived by the owner on Aug 14, 2023. It is now read-only.
SDK Restricted Wasm (prerequisite for the Fixed-Gas) #228
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
YaronWittenstein
added
big
YaronWittenstein
force-pushed
the
fixed-gas
branch
from
4afbf1a to
7ecd304
Compare
Implemented the `svm_allocate` host function. adding some debugging printing to the new `svm_allocate` host function. WIP: computing the `returns` byte-size for a function (sdk-macros) * `calldata` is allocated on instance only when non-empty. The `svm-sdk` relies on the host function for Wasm targeted code and on the default global allocator otherwise. adding `svm_sdk_std::panic` (aborts for Wasm and unwinds otherwise) WIP: adding an explicit feature flag for the host static allocation. svm-codec is using the default global-alloactor (not the "static allocation") codec - js tests pass (commenting the `verify_data` for now) tests pass CI - running only on Windows + running the tests 10 times (there seems to be a sporadic failures) CI - skipping the build stage svm-sdk-std: exposing Rust `Vec` svm-sdk-std: using `panic!` running only the `svm-runtime` crate tests. Removing `wabt` (using only `wat`) - it takes much less time to build. using cache action v2 Adding GitHub Action for LLVM Adding caching to the llvm LLVM 10 Returning back the original LLVM action for Windows adding feature-flags `default-cranelift` and `default-llvm` trying to run CI against `llvm` running tests with a single thread runtime - removing two ignored tests related to gas-metering Commenting a test runtime: ignoring all tests except one running tests in dev-mode Building on Linux and macOS svm-sdk-std: returning back Rust `Vec` Commenting part of the problematic test Commenting another part of the problematic test uncomment part of the problematic test cbindgen version bump problemtic test - wasm input file "runtime_calldata.wasm" isn't using the "static-alloc" problemtic test: input wasm is being compiled with less code and no `.cargo/config` file Uncommenting all the problematic test Trying to locate the bug Trying again to pinpoint the bug Adding asserts against setting explicitly empty `returndata` WIP: debugging WIP: debugging... WIP: debugging... skipping the last CI stages for now... WIP: trying to locate the cause of the bug... WIP commenting the "static-alloc" related code from `svm-sdk-alloc` WIP Trying again to make the test fail Trying to figure out whether the #[endpoint] return-type has anything to do with the bug... Commenting "Storage" from the wasm input of the failing test... More debugging the root cause of the problem debugging... adding "Cache workspace" step Splitting cargo caching into isloated steps. adding "Dump GitHub context" step. CI: changing to `crates/runtime` before running the tests Try again to run CI... Try again CI: disabling LLVM installation for now (Windows) Trying again to reproduce a broken CI on Windows... Checking whether the bug has something to do with `svm_sdk::Address` Trying to find a minimal failing input using `Amount` WIP: Debugging... WIP: removing the parameter from the problematic endpoint This should pass (not using `endpoint`) This should fail again... `ExtHost#get_calldata` - returning a static data Re-compile the wasm input Empty `endpoint` prologue. debugging debugging... Trying to narrow the bug WIP Narrowing the epilogue part should fail... Uncommenting part of the epilogue WIP
YaronWittenstein
force-pushed
the
fixed-gas
branch
from
a0e3b0a to
1b25f4a
Compare
… the endpoint's macro.
YaronWittenstein
force-pushed
the
fixed-gas
branch
4 times, most recently
from
1637cc4 to
146afac
Compare
YaronWittenstein
force-pushed
the
fixed-gas
branch
from
146afac to
adf3d31
Compare
moshababo
approved these changes
Apr 28, 2021
YaronWittenstein
changed the title
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
We want the Wasm-compiled code of SVM Apps to have restrictions that will enable us to give fixed-gas estimations for transactions.
From the end-user point of view, he/she will know prior to dispatching a transaction to the network the exact quantity of gas units required to execute the transaction without hitting the
out of gaserror.Having said that, a transaction can still fail - for example by
panic-ing.A restricted Wasm program should meet the following:
loopopcode.call_indirectopcode (no function pointers, i.e no Polymorphism).In order to achieve the above, the PR adds a crate named
svm-sdk-stdthat will serve as a tiny replacement for the default Ruststd. By introducing this crate we have full control of the emitted Wasm and we can cherry-pick only features that are relevant for us. Many places in the code base have been adapted to use this crate.A special note should be given to heap-allocation. Since running transactions are short-lived programs, we can shun away from deallocations of heap memory. Also, we can have a fixed amount of Wasm memory allocated upon instance initialization.
Consequently, this PR adds a feature flag named
static-allocthat is enabled for SVM Apps. Theglobal allocatorused when running such programs is delegating the allocation to theHost(it merely increments the total size of allocated memory).There are pieces of common code (mainly
encodingrelated) that are shared by thesvm-codeccrate and the SVM Apps.When used in the context of the
codeca feature flag nameddynamic-allocis being used.By turning on this feature flag, the code of the
svm_codec.wasmartifact is self-contained. We need it to be so since it's a component that should be used from withinsmapp(or similar). So we end up having the allocation code is embedded within as opposed to SVM Apps that rely on theHostto do the allocation).A feature PR will add static-code analysis to check for Wasm programs inputs validity (as part of the
deploy-templateflow)and it will also expose the
gas costs calculationfor transactions. (spawn-appandexec-apptransactions).other: This PR also rewrites the GitHub Actions workflow to be more robust.