This is an automated email from the ASF dual-hosted git repository.
junrushao pushed a commit to branch unity
in repository https://gitbox.apache.org/repos/asf/tvm.git
The following commit(s) were added to refs/heads/unity by this push:
new 49fc613a3c [Unity][WEBGPU] Enable wasm exception propagation (#16330)
49fc613a3c is described below
commit 49fc613a3c55c679bcd98508828f5ec6bc6a13e3
Author: Tianqi Chen <[email protected]>
AuthorDate: Thu Jan 4 12:54:50 2024 -0500
[Unity][WEBGPU] Enable wasm exception propagation (#16330)
This PR enables wasm exception propagation among
c++ runtime generated wasm and javascript.
Right now the error.message is passed back
this would allow us to do some handling in webgpu
related exceptions raised through FFI boundaries.
Note that this would require the latest emscripten
and on the nodejs, --experimental-wasm-eh support.
---
python/tvm/contrib/emcc.py | 1 +
web/Makefile | 2 +-
web/emcc/tvmjs_support.cc | 11 +++++++++--
web/package.json | 2 +-
web/src/ctypes.ts | 5 +++++
web/src/runtime.ts | 31 ++++++++++++++++++++++++++++---
web/tests/node/test_packed_func.js | 15 +++++++++++++++
7 files changed, 60 insertions(+), 7 deletions(-)
diff --git a/python/tvm/contrib/emcc.py b/python/tvm/contrib/emcc.py
index d62b22f1e8..73cb33dfcc 100644
--- a/python/tvm/contrib/emcc.py
+++ b/python/tvm/contrib/emcc.py
@@ -42,6 +42,7 @@ def create_tvmjs_wasm(output, objects, options=None,
cc="emcc"):
cmd += ["-O3"]
cmd += ["-std=c++17"]
cmd += ["--no-entry"]
+ cmd += ["-fwasm-exception"]
cmd += ["-s", "WASM_BIGINT=1"]
cmd += ["-s", "ERROR_ON_UNDEFINED_SYMBOLS=0"]
cmd += ["-s", "STANDALONE_WASM=1"]
diff --git a/web/Makefile b/web/Makefile
index 8fccf9636c..bd5e6cbf2b 100644
--- a/web/Makefile
+++ b/web/Makefile
@@ -27,7 +27,7 @@ all: dist/wasm/tvmjs_runtime.wasm
dist/wasm/tvmjs_runtime.wasi.js src/tvmjs_runt
EMCC = emcc
-EMCC_CFLAGS = $(INCLUDE_FLAGS) -O3 -std=c++17 -Wno-ignored-attributes
+EMCC_CFLAGS = $(INCLUDE_FLAGS) -O3 -std=c++17 -Wno-ignored-attributes
-fwasm-exceptions
EMCC_LDFLAGS = --no-entry -s WASM_BIGINT=1 -s ALLOW_MEMORY_GROWTH=1 -s
STANDALONE_WASM=1\
-s ERROR_ON_UNDEFINED_SYMBOLS=0 --pre-js emcc/preload.js
diff --git a/web/emcc/tvmjs_support.cc b/web/emcc/tvmjs_support.cc
index a314f08fb4..324dcf7fd0 100644
--- a/web/emcc/tvmjs_support.cc
+++ b/web/emcc/tvmjs_support.cc
@@ -148,8 +148,15 @@ class AsyncLocalSession : public LocalSession {
int code = args[0];
TVMRetValue rv;
rv = args[1];
- this->EncodeReturn(std::move(rv),
- [&](TVMArgs encoded_args) {
callback(RPCCode::kReturn, encoded_args); });
+ if (code == static_cast<int>(RPCCode::kReturn)) {
+ this->EncodeReturn(std::move(rv), [&](TVMArgs encoded_args) {
+ callback(RPCCode::kReturn, encoded_args);
+ });
+ } else {
+ // for exception, we can pass through as since this is just normal
encoding.
+ ICHECK_EQ(code, static_cast<int>(RPCCode::kException));
+ callback(RPCCode::kException, args);
+ }
});
TVMRetValue temp;
diff --git a/web/package.json b/web/package.json
index 95a5c8efd7..779152ede2 100644
--- a/web/package.json
+++ b/web/package.json
@@ -13,7 +13,7 @@
"build": "rollup -c",
"lint": "eslint -c .eslintrc.json .",
"typedoc": "typedoc src/index.ts --plugin typedoc-plugin-missing-exports",
- "test": "jest",
+ "test": "node --experimental-wasm-eh node_modules/.bin/jest",
"bundle": "npm run build && cp lib/index.js dist/index.js && cp
lib/index.js dist/tvmjs.bundle.js",
"example": "npm run bundle && node apps/node/example.js",
"example:wasi": "npm run bundle && node
--experimental-wasi-unstable-preview1 --experimental-wasm-bigint
apps/node/wasi_example.js",
diff --git a/web/src/ctypes.ts b/web/src/ctypes.ts
index 282679fc02..cb2a0e1097 100644
--- a/web/src/ctypes.ts
+++ b/web/src/ctypes.ts
@@ -33,6 +33,11 @@ export type PtrOffset = number;
*/
export type FTVMGetLastError = () => Pointer;
+/**
+ * void TVMAPISetLastError(const char* msg);
+ */
+export type FTVMAPISetLastError = (msg: Pointer) => void;
+
/**
* int TVMModGetFunction(TVMModuleHandle mod,
* const char* func_name,
diff --git a/web/src/runtime.ts b/web/src/runtime.ts
index 5aa38dee39..4c56005261 100644
--- a/web/src/runtime.ts
+++ b/web/src/runtime.ts
@@ -78,6 +78,7 @@ class FFILibrary implements Disposable {
if (code != 0) {
const msgPtr = (this.exports
.TVMGetLastError as ctypes.FTVMGetLastError)();
+ console.log("Here");
throw new Error("TVMError: " + this.memory.loadCString(msgPtr));
}
}
@@ -1902,10 +1903,15 @@ export class Instance implements Disposable {
// need to keep it alive until callback is fulfilled.
const callback = this.detachFromCurrentScope(args[args.length - 1] as
PackedFunc);
const promise: Promise<any> = func(...fargs);
- promise.then((rv: any) => {
+ const onFulfilled = (rv: any) => {
callback(this.scalar(AsyncCallbackCode.kReturn, "int32"), rv);
callback.dispose();
- });
+ };
+ const onRejected = (reason: any) => {
+ callback(this.scalar(AsyncCallbackCode.kException, "int32"),
reason.toString());
+ callback.dispose();
+ };
+ promise.then(onFulfilled, onRejected);
};
this.registerFunc("__async." + name, asyncVariant, override);
}
@@ -2216,7 +2222,26 @@ export class Instance implements Disposable {
jsArgs.push(this.retValueToJS(valuePtr, tcode, true));
}
- const rv = func(...jsArgs);
+ let rv: any;
+ try {
+ rv = func(...jsArgs);
+ } catch (error) {
+ // error handling
+ // store error via SetLastError
+ this.ctx.endScope();
+ const errMsg = "JSCallbackError: " + error.message;
+ const stack = lib.getOrAllocCallStack();
+ const errMsgOffset = stack.allocRawBytes(errMsg.length + 1);
+ stack.storeRawBytes(errMsgOffset, StringToUint8Array(errMsg));
+ stack.commitToWasmMemory();
+ (this.lib.exports.TVMAPISetLastError as ctypes.FTVMAPISetLastError)(
+ stack.ptrFromOffset(errMsgOffset)
+ );
+ this.lib.recycleCallStack(stack);
+ return -1;
+ }
+
+ // normal return path
// recycle all js object value in function unless we want to retain them.
this.ctx.endScope();
diff --git a/web/tests/node/test_packed_func.js
b/web/tests/node/test_packed_func.js
index 04b91c861d..f5c0ac6c2f 100644
--- a/web/tests/node/test_packed_func.js
+++ b/web/tests/node/test_packed_func.js
@@ -126,6 +126,21 @@ test("RegisterGlobal", () => {
tvm.endScope();
});
+test("ExceptionPassing", () => {
+ tvm.beginScope();
+ tvm.registerFunc("throw_error", function (msg) {
+ throw Error(msg);
+ });
+ let f = tvm.getGlobalFunc("throw_error");
+ try {
+ f("error-xyz");
+ throw Error("error not caught");
+ } catch (error) {
+ assert(error.message.indexOf("error-xyz") != -1);
+ }
+ tvm.endScope();
+});
+
test("NDArrayCbArg", () => {
tvm.beginScope();
let use_count = tvm.getGlobalFunc("testing.object_use_count");
