Merge pull request #478 from Concordium/ar/cor-2473-implement-a-default-allocator-for-concordium-std-on-wasm32

Ar/cor 2473 implement a default allocator for concordium std on wasm32

Author: allanbrondum

.github/workflows/build-test.yml

@@ -76,15 +76,15 @@ jobs:
         with:
           submodules: recursive
       - name: Run internal wasm unit test
-        working-directory: concordium-std
+        working-directory: concordium-std-internal-test
         run: |
           # curl -L https://github.com/Concordium/concordium-smart-contract-tools/releases/download/releases/cargo-concordium/${CARGO_CONCORDIUM_VERSION}/cargo-concordium-linux-amd64 -o /tmp/cargo-concordium
           # chmod +x /tmp/cargo-concordium
           # sudo mv /tmp/cargo-concordium /usr/bin/cargo-concordium
           # todo change to use release as part of https://linear.app/concordium/issue/COR-2479/release-for-wasm32v1
           rustup target add wasm32v1-none          
           cargo install --git https://github.com/Concordium/concordium-smart-contract-tools.git --branch feature/wasm32v1 --locked
-          cargo concordium test --only-unit-tests -- --features internal-wasm-test
+          cargo concordium test --only-unit-tests
 
   std_clippy_wasm32v1:
     name: Clippy on concordium-std for wasm32v1 target
@@ -99,7 +99,7 @@ jobs:
         run: |
           rustup component add clippy
           rustup target add wasm32v1-none
-          cargo clippy --target wasm32v1-none -- -D warnings
+          cargo clippy --target wasm32v1-none --features wasm-test,build-schema,bump_alloc,debug -- -D warnings
 
   std_check:
     name: Check on concordium-std for x64 and wasm32 and different features
@@ -113,11 +113,15 @@ jobs:
         working-directory: concordium-std
         run: |
           # Try different feature combinations on default (x86 linux) target
+          cargo check --no-default-features
           cargo check
 
           # Try different feature combinations on wasm32v1 target
           rustup target add wasm32v1-none
-          cargo check --target wasm32v1-none 
+          cargo check --target wasm32v1-none --no-default-features
+          cargo check --target wasm32v1-none --no-default-features --features bump_alloc
+          cargo check --target wasm32v1-none --no-default-features --features dlmalloc
+          cargo check --target wasm32v1-none
           cargo check --target wasm32v1-none --features wasm-test
           cargo check --target wasm32v1-none --features build-schema
           cargo check --target wasm32v1-none --features bump_alloc

Cargo.toml

@@ -4,6 +4,7 @@ resolver = "3"
 members = [
    "concordium-cis2",
    "concordium-std",
+   "concordium-std-internal-test",
    "concordium-std-derive",
    "contract-testing",
 ]

concordium-cis2/Cargo.toml

@@ -38,11 +38,8 @@ serde = [
     "primitive-types/impl-serde",
 ]
 
-[lib]
-crate-type = ["rlib"]
-
 [package.metadata.docs.rs]
-# This sets the default target to `wasm32-unknown-unknown` and only builds that
+# This sets the default target to `wasm32v1-none` and only builds that
 # target on docs.rs. This is useful because the some parts of documentation only
 # exist on that platform.
 targets = ["wasm32v1-none"]

concordium-std-internal-test/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "concordium-std-internal-test"
+version = "1.0.0"
+authors = ["Concordium <developers@concordium.com>"]
+edition = "2024"
+rust-version = "1.85"
+license = "MPL-2.0"
+
+[dependencies]
+concordium-std = { path = "../concordium-std", features = ["internal-wasm-test", "wasm-test"]}
+
+[lib]
+crate-type = ["cdylib", "rlib"]

concordium-std-internal-test/README.md

@@ -0,0 +1,2 @@
+Crate whose only purpose is to build the internal tests in `concordium-std` into a WASM file, such that they can
+be run by `cargo concoridum test`.

concordium-std-internal-test/src/lib.rs

@@ -0,0 +1,3 @@
+#![no_std]
+
+extern crate concordium_std;

concordium-std/CHANGELOG.md

@@ -3,9 +3,13 @@
 ## Unreleased
 
 - Removed the native test `StateTrie`
-- The crate now targets [`wasm32v1-none`](https://doc.rust-lang.org/rustc/platform-support/wasm32v1-none.html) as the supported WASM target. The crate also no longer has an `std` crate feature. 
-  Smart contracts using `concordium-std` should specify `#[no_std]` and compile to `wasm32v1-none`. 
-  The `concordium-std` crate still supports compiling to targets like x86 linux (for unit testing e.g.), in which case the crate will add the Rust `std` crate as a dependency.
+- The crate is now intended for use on the [`wasm32v1-none`](https://doc.rust-lang.org/rustc/platform-support/wasm32v1-none.html) target, which is a `no_std` target.   
+  Smart contracts using `concordium-std` should specify `#[no_std]` and compile to the target `wasm32v1-none`. The previously supported target `wasm32-unknown-unknown`
+  (which has a partly stubbed `std` implementation) is no longer supported with `concordium-std`. The crate feature `std` has likewise been removed. 
+  The allocator used by default by `concordium-std` is [`dlmalloc`](https://crates.io/crates/dlmalloc). The crate feature `bump_alloc` 
+  will switch to use the custom, lightweight `bump_alloc` allocator. 
+  Notice that `dlmalloc` is the same as used by the `std` implementation of `wasm32-unknown-unknown`. 
+  The `concordium-std` crate still supports compiling to targets like x64 linux (for unit testing e.g.), in which case the crate will add the Rust `std` crate as a dependency.
 - The crate feature `p7` has been removed. The functionality it guarded (related to protocol P7) is unconditionally compiled.
 - The crate feature `crypto-primitives` has been removed. It had no effect anymore (was previously used by the now deprecated test infrastructure).
 - The types `StateMap` and `StateSet` and related types no longer requires the low-level state type to be specified. 

concordium-std/Cargo.toml

@@ -11,6 +11,7 @@ repository = "https://github.com/Concordium/concordium-rust-smart-contracts/"
 readme = "./README.md"
 
 [dependencies]
+dlmalloc = { version = "0.2.14", features = ["global"], optional = true }
 quickcheck = {version = "1", optional = true }
 getrandom = { version = "0.2", features = ["custom"], optional = true }
 
@@ -21,7 +22,7 @@ default-features = false
 features = ["smart-contract"]
 
 [features]
-default = ["bump_alloc"]
+default = ["dlmalloc"]
 # Enabling the wasm-test feature changes the #[concoridum_test] macro to output test functions callable from WASM interpreter
 wasm-test = ["concordium-contracts-common/wasm-test"]
 # Own internal wasm-tests leak out to the smart contracts using this library,
@@ -33,13 +34,11 @@ build-schema = ["concordium-contracts-common/build-schema"]
 concordium-quickcheck = ["getrandom", "quickcheck", "concordium-contracts-common/concordium-quickcheck"] # // decide what to do with this feature flag as part of https://linear.app/concordium/issue/COR-2474/property-based-tests-on-wasm32-target
 # Enabling debug feature changes the #[concoridum_dbg] macro to log messages via the WASM interpreter
 debug = []
-# Custom allocator. See module documentation for bump_alloc in this crate
+# Use the dlmalloc allocator
+dlmalloc = ["dep:dlmalloc"]
+# Use the custom bump allocator instead of dlmalloc. See module documentation for bump_alloc in this crate.
 bump_alloc = []
 
-[lib]
-# cdylib is needed below to compile into a wasm module with internal unit tests.
-crate-type = ["cdylib", "rlib"]
-
 [dev-dependencies]
 trybuild = "1.0"
 
@@ -48,3 +47,5 @@ trybuild = "1.0"
 # target on docs.rs. This is useful because the some parts of documentation only
 # exist on that platform.
 targets = ["wasm32v1-none"]
+# Default features to build documentation for.
+features = ["debug"]