feat: merge upstream 0.16.3

.github/workflows/builds_and_tests.yml

@@ -9,7 +9,7 @@ jobs:
       - name: Install Rust
         uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.51.0
+          toolchain: 1.55.0
           target: wasm32-unknown-unknown
           profile: minimal
           override: true
@@ -19,22 +19,27 @@ jobs:
         uses: actions/cache@v2
         with:
           path: ~/.cargo
-          key: cargocache-v2-libwasmvm_sanity-rust:1.51.0-${{ hashFiles('Cargo.lock') }}
+          key: cargocache-v2-libwasmvm_sanity-rust:1.55.0-${{ hashFiles('Cargo.lock') }}
       - name: Install shellcheck
         run: sudo apt install shellcheck
       - name: Show version information
         run: rustc --version; cargo --version; rustup --version
       - name: Add Rust components
         run: rustup component add clippy rustfmt
       - name: Check formatting
+        working-directory: ./libwasmvm
         run: cargo fmt -- --check
       - name: Run linter
+        working-directory: ./libwasmvm
         run: cargo clippy -- -D warnings
       - name: Run unit tests
+        working-directory: ./libwasmvm
         run: cargo test
       - name: Build docs
+        working-directory: ./libwasmvm
         run: cargo doc --no-deps
       - name: Test docs
+        working-directory: ./libwasmvm
         run: |
             sed -i  '/^crate-type = \["cdylib"\]/d' Cargo.toml
             cargo test --doc
@@ -86,7 +91,7 @@ jobs:
       - name: Install Rust
         uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.51.0
+          toolchain: 1.55.0
           target: wasm32-unknown-unknown
           profile: minimal
           override: true
@@ -96,7 +101,7 @@ jobs:
         uses: actions/cache@v2
         with:
           path: ~/.cargo
-          key: cargocache-v2-build_shared_library-rust:1.51.0-${{ hashFiles('Cargo.lock') }}
+          key: cargocache-v2-build_shared_library-rust:1.55.0-${{ hashFiles('Cargo.lock') }}
       - name: Show version information
         run: rustc --version; cargo --version; rustup --version
       - name: Create release build of libwasmvm

.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
   package-version: # emit package version using `cargo tree -i`
     name: Get Package Version
     runs-on: ubuntu-latest
-    container: rust:1.53.0-slim
+    container: rust:1.55.0-slim
     outputs:
       version: ${{ steps.get-version.outputs.version }}
     steps:
@@ -31,6 +31,7 @@ jobs:
           key: ${{ runner.os }}-cargo-home-${{ hashFiles('**/Cargo.lock') }}
       - name: Get package version
         id: get-version
+        working-directory: ./libwasmvm
         run: |
           VERSION=$(cargo tree -i wasmvm | grep -oE "[0-9]+(\.[0-9]+){2}-[0-9]+(\.[0-9]+){2}")
           echo ::set-output name=version::${VERSION}

.gitignore

@@ -1,4 +1,4 @@
-/target
+target/
 **/*.rs.bk
 *.iml
 .idea
@@ -10,5 +10,6 @@ lib*.a
 artifacts/
 muslc.exe
 static.exe
+/demo
 tmp
 a.out

Makefile

@@ -4,48 +4,42 @@ BUILDERS_PREFIX := line/wasmvm-builder
 USER_ID := $(shell id -u)
 USER_GROUP = $(shell id -g)
 
-DLL_EXT = ""
+SHARED_LIB_EXT = "" # File extension of the shared library
 ifeq ($(OS),Windows_NT)
-	DLL_EXT = dll
+	SHARED_LIB_EXT = dll
 else
 	UNAME_S := $(shell uname -s)
 	ifeq ($(UNAME_S),Linux)
-		DLL_EXT = so
+		SHARED_LIB_EXT = so
 	endif
 	ifeq ($(UNAME_S),Darwin)
-		DLL_EXT = dylib
+		SHARED_LIB_EXT = dylib
 	endif
 endif
 
 all: build test
 
 build: build-rust build-go
 
-# don't strip for now, for better error reporting
-# build-rust: build-rust-release strip
 build-rust: build-rust-release
 
 # Use debug build for quick testing.
 # In order to use "--features backtraces" here we need a Rust nightly toolchain, which we don't have by default
 build-rust-debug:
-	cargo build
-	cp target/debug/libwasmvm.$(DLL_EXT) api
+	(cd libwasmvm && cargo build)
+	cp libwasmvm/target/debug/libwasmvm.$(SHARED_LIB_EXT) api
+	make update-bindings
 
 # use release build to actually ship - smaller and much faster
+#
+# See https://github.com/CosmWasm/wasmvm/issues/222#issuecomment-880616953 for two approaches to
+# enable stripping through cargo (if that is desired).
 build-rust-release:
-	cargo build --release
-	cp target/release/libwasmvm.$(DLL_EXT) api
+	(cd libwasmvm && cargo build --release)
+	cp libwasmvm/target/release/libwasmvm.$(SHARED_LIB_EXT) api
+	make update-bindings
 	@ #this pulls out ELF symbols, 80% size reduction!
 
-# implement stripping based on os
-ifeq ($(DLL_EXT),so)
-strip:
-	strip api/libwasmvm.so
-else
-# TODO: add for windows and osx
-strip:
-endif
-
 build-go:
 	go build ./...
 
@@ -57,46 +51,61 @@ test-safety:
 
 # Creates a release build in a containerized build environment of the static library for Alpine Linux (.a)
 release-build-alpine:
-	rm -rf target/release
+	rm -rf libwasmvm/target/release
 	# build the muslc *.a file
-	docker run --rm -v $(shell pwd):/code $(BUILDERS_PREFIX):alpine
+	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd)/libwasmvm:/code $(BUILDERS_PREFIX):alpine
+	cp libwasmvm/target/release/examples/libstaticlib.a api/libwasmvm_static.a
+	make update-bindings
 	# try running go tests using this lib with muslc
-	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd):/code -w /code $(BUILDERS_PREFIX):alpine go build -tags static .
-	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd):/code -w /code $(BUILDERS_PREFIX):alpine go test -tags='static mocks' ./api ./types
+	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd):/testing -w /testing $(BUILDERS_PREFIX):alpine go build -tags static .
+	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd):/testing -w /testing $(BUILDERS_PREFIX):alpine go test -tags 'static mocks' ./api ./types
 
 # Creates a release build in a containerized build environment of the static library for glibc Linux (.a)
 release-build-linux-static:
-	rm -rf target/release
+	rm -rf libwasmvm/target/release
 	# build the glibc *.a file
-	docker run --rm -v $(shell pwd):/code $(BUILDERS_PREFIX):static
+	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd)/libwasmvm:/code $(BUILDERS_PREFIX):static
+	cp libwasmvm/target/release/examples/libstaticlib.a api/libwasmvm_static.a
+	make update-bindings
 	# try running go tests using this lib with glibc
-	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd):/code -w /code $(BUILDERS_PREFIX):static go build -tags static .
-	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd):/code -w /code $(BUILDERS_PREFIX):static go test -tags='static mocks' ./api ./types
+	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd):/testing -w /testing $(BUILDERS_PREFIX):static go build -tags static .
+	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd):/testing -w /testing $(BUILDERS_PREFIX):static go test -tags='static mocks' ./api ./types
 
 # Creates a release build in a containerized build environment of the shared library for glibc Linux (.so)
 release-build-linux:
-	rm -rf target/release
-	docker run --rm -v $(shell pwd):/code $(BUILDERS_PREFIX):centos7
+	rm -rf libwasmvm/target/release
+	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd)/libwasmvm:/code $(BUILDERS_PREFIX):centos7
+	cp libwasmvm/target/release/deps/libwasmvm.so api
+	make update-bindings
 
 # Creates a release build in a containerized build environment of the shared library for macOS (.dylib)
 release-build-macos:
-	rm -rf target/release
-	docker run --rm -v $(shell pwd):/code $(BUILDERS_PREFIX):cross
+	rm -rf libwasmvm/target/release
+	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd)/libwasmvm:/code $(BUILDERS_PREFIX):cross
+	cp libwasmvm/target/x86_64-apple-darwin/release/deps/libwasmvm.dylib api
+	cp libwasmvm/bindings.h api
+	make update-bindings
+
+update-bindings:
+	# After we build libwasmvm, we have to copy the generated bindings for Go code to use.
+	# We cannot use symlinks as those are not reliably resolved by `go get` (https://github.com/CosmWasm/wasmvm/pull/235).
+	cp libwasmvm/bindings.h api
 
 release-build:
-	# Write like this because those must not run in parallal
+	# Write like this because those must not run in parallel
 	make release-build-alpine
 	make release-build-linux
 	make release-build-linux-static
 	make release-build-macos
 
 test-alpine: release-build-alpine
 	# build a go binary
-	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd):/code -w /code $(BUILDERS_PREFIX):alpine go build -tags='static mocks' -o muslc.exe ./cmd
+	docker run --rm -u $(USER_ID):$(USER_GROUP) -v $(shell pwd):/testing -w /testing $(BUILDERS_PREFIX):alpine go build -tags 'static mocks' -o demo ./cmd
 	# run static binary in an alpine machines (not dlls)
-	docker run --rm --read-only -v $(shell pwd):/code -w /code alpine:3.12 ./muslc.exe ./api/testdata/hackatom.wasm
-	docker run --rm --read-only -v $(shell pwd):/code -w /code alpine:3.11 ./muslc.exe ./api/testdata/hackatom.wasm
-	docker run --rm --read-only -v $(shell pwd):/code -w /code alpine:3.10 ./muslc.exe ./api/testdata/hackatom.wasm
+	docker run --rm --read-only -v $(shell pwd):/testing -w /testing alpine:3.14 ./demo ./api/testdata/hackatom.wasm
+	docker run --rm --read-only -v $(shell pwd):/testing -w /testing alpine:3.13 ./demo ./api/testdata/hackatom.wasm
+	docker run --rm --read-only -v $(shell pwd):/testing -w /testing alpine:3.12 ./demo ./api/testdata/hackatom.wasm
+	docker run --rm --read-only -v $(shell pwd):/testing -w /testing alpine:3.11 ./demo ./api/testdata/hackatom.wasm
 	# run static binary locally if you are on Linux
 	# ./muslc.exe ./api/testdata/hackatom.wasm
 

NOTICE

@@ -1,4 +1,4 @@
-Copyright 2019-2020 Confio OÜ
+Copyright 2019-2021 Confio OÜ
 Copyright 2021 LINE Plus Corporation
 
 Licensed under the Apache License, Version 2.0 (the "License");

api/bindings.h

@@ -186,8 +186,20 @@ typedef struct UnmanagedVector {
   uintptr_t cap;
 } UnmanagedVector;
 
+/**
+ * The result type of the FFI function analyze_code.
+ *
+ * Please note that the unmanaged vector in `required_features`
+ * has to be destroyed exactly once. When calling `analyze_code`
+ * from Go this is done via `C.destroy_unmanaged_vector`.
+ */
 typedef struct AnalysisReport {
   bool has_ibc_entry_points;
+  /**
+   * An UTF-8 encoded comma separated list of reqired features.
+   * This is never None/nil.
+   */
+  struct UnmanagedVector required_features;
 } AnalysisReport;
 
 typedef struct Metrics {

api/callbacks.go

@@ -40,6 +40,7 @@ import (
 	"fmt"
 	"log"
 	"reflect"
+	"runtime/debug"
 	"unsafe"
 
 	"github.com/line/wasmvm/types"
@@ -72,6 +73,7 @@ func recoverPanic(ret *C.GoResult) {
 		// 	case "ErrorGasOverflow":
 		default:
 			log.Printf("Panic in Go callback: %#v\n", rec)
+			debug.PrintStack()
 			*ret = C.GoResult_Panic
 		}
 	}

api/lib.go

@@ -108,6 +108,7 @@ func AnalyzeCode(cache Cache, checksum []byte) (*types.AnalysisReport, error) {
 	}
 	res := types.AnalysisReport{
 		HasIBCEntryPoints: bool(report.has_ibc_entry_points),
+		RequiredFeatures:  string(copyAndDestroyUnmanagedVector(report.required_features)),
 	}
 	return &res, nil
 }
@@ -369,7 +370,7 @@ func IBCChannelOpen(
 	cache Cache,
 	checksum []byte,
 	env []byte,
-	channel []byte,
+	msg []byte,
 	gasMeter *GasMeter,
 	store KVStore,
 	api *GoAPI,
@@ -381,8 +382,8 @@ func IBCChannelOpen(
 	defer runtime.KeepAlive(checksum)
 	e := makeView(env)
 	defer runtime.KeepAlive(env)
-	ch := makeView(channel)
-	defer runtime.KeepAlive(channel)
+	m := makeView(msg)
+	defer runtime.KeepAlive(msg)
 
 	// set up a new stack frame to handle iterators
 	counter := startContract()
@@ -395,7 +396,7 @@ func IBCChannelOpen(
 	var gasUsed cu64
 	errmsg := newUnmanagedVector(nil)
 
-	res, err := C.ibc_channel_open(cache.ptr, cs, e, ch, db, a, q, cu64(gasLimit), cbool(printDebug), &gasUsed, &errmsg)
+	res, err := C.ibc_channel_open(cache.ptr, cs, e, m, db, a, q, cu64(gasLimit), cbool(printDebug), &gasUsed, &errmsg)
 	if err != nil && err.(syscall.Errno) != C.ErrnoValue_Success {
 		// Depending on the nature of the error, `gasUsed` will either have a meaningful value, or just 0.
 		return nil, uint64(gasUsed), errorWithMessage(err, errmsg)
@@ -407,7 +408,7 @@ func IBCChannelConnect(
 	cache Cache,
 	checksum []byte,
 	env []byte,
-	channel []byte,
+	msg []byte,
 	gasMeter *GasMeter,
 	store KVStore,
 	api *GoAPI,
@@ -419,8 +420,8 @@ func IBCChannelConnect(
 	defer runtime.KeepAlive(checksum)
 	e := makeView(env)
 	defer runtime.KeepAlive(env)
-	ch := makeView(channel)
-	defer runtime.KeepAlive(channel)
+	m := makeView(msg)
+	defer runtime.KeepAlive(msg)
 
 	// set up a new stack frame to handle iterators
 	counter := startContract()
@@ -433,7 +434,7 @@ func IBCChannelConnect(
 	var gasUsed cu64
 	errmsg := newUnmanagedVector(nil)
 
-	res, err := C.ibc_channel_connect(cache.ptr, cs, e, ch, db, a, q, cu64(gasLimit), cbool(printDebug), &gasUsed, &errmsg)
+	res, err := C.ibc_channel_connect(cache.ptr, cs, e, m, db, a, q, cu64(gasLimit), cbool(printDebug), &gasUsed, &errmsg)
 	if err != nil && err.(syscall.Errno) != C.ErrnoValue_Success {
 		// Depending on the nature of the error, `gasUsed` will either have a meaningful value, or just 0.
 		return nil, uint64(gasUsed), errorWithMessage(err, errmsg)
@@ -445,7 +446,7 @@ func IBCChannelClose(
 	cache Cache,
 	checksum []byte,
 	env []byte,
-	channel []byte,
+	msg []byte,
 	gasMeter *GasMeter,
 	store KVStore,
 	api *GoAPI,
@@ -457,8 +458,8 @@ func IBCChannelClose(
 	defer runtime.KeepAlive(checksum)
 	e := makeView(env)
 	defer runtime.KeepAlive(env)
-	ch := makeView(channel)
-	defer runtime.KeepAlive(channel)
+	m := makeView(msg)
+	defer runtime.KeepAlive(msg)
 
 	// set up a new stack frame to handle iterators
 	counter := startContract()
@@ -471,7 +472,7 @@ func IBCChannelClose(
 	var gasUsed cu64
 	errmsg := newUnmanagedVector(nil)
 
-	res, err := C.ibc_channel_close(cache.ptr, cs, e, ch, db, a, q, cu64(gasLimit), cbool(printDebug), &gasUsed, &errmsg)
+	res, err := C.ibc_channel_close(cache.ptr, cs, e, m, db, a, q, cu64(gasLimit), cbool(printDebug), &gasUsed, &errmsg)
 	if err != nil && err.(syscall.Errno) != C.ErrnoValue_Success {
 		// Depending on the nature of the error, `gasUsed` will either have a meaningful value, or just 0.
 		return nil, uint64(gasUsed), errorWithMessage(err, errmsg)