support app framework base library in assemblyscript (#164)

Author: xujuntwt95329

assembly-script/README.md

@@ -0,0 +1,124 @@
+# AssemblyScript_on_WAMR
+This project is based on [Wasm Micro Runtime](https://github.com/bytecodealliance/wasm-micro-runtime) (WAMR) and [AssemblyScript](https://github.com/AssemblyScript/assemblyscript). It implements some of the `wamr app framework` in *assemblyscript*, which allows you to write some applications in *assemblyscript* and dynamically installed on *WAMR Runtime*
+
+## Building
+To build the samples in this repo, you need `npm` on your system
+``` bash
+sudo apt install npm
+```
+
+Then install all the dependencies under the repo's root dir
+``` bash
+cd $repo_root
+npm install
+```
+
+Use the command to build all samples:
+``` bash
+npm run build:all
+```
+or you can build every sample individually:
+``` bash
+npm run build:timer
+npm run build:publisher
+npm run build:subscriber
+# ...
+```
+You will get the compiled wasm file under `build` folder
+
+Please refer to [package.json](./package.json) for more commands.
+
+## Run
+These applications require WAMR's application framework, you need to build WAMR first.
+
+``` bash
+cd ${WAMR_ROOT}/samples/simple
+./build.sh
+```
+
+You will get two executable files under `out` folder:
+
+`simple`: The wamr runtime with application framework
+
+`host_tool`: The tool used to dynamically install/uninstall applications
+
+1. Start the runtime:
+    ``` bash
+    ./simple -s
+    ```
+
+2. Install the compiled wasm file using `host_tool`:
+    ``` bash
+    ./host_tool -i app_name -f your_compiled_wasm_file.wasm
+    ```
+You can also use the WAMR's AoT compiler `wamrc` to compile the wasm bytecode into native code before you run them. Please refer to this [guide](../README.md#build-wamrc-aot-compiler) to build and install `WAMR AoT compiler`.
+
+After installing `wamrc`, you can compile the wasm file using command:
+``` bash
+wamrc -o file_name.aot file_name.wasm
+```
+and you can install the AoT file to the runtime:
+``` bash
+./host_tool -i app_name -f your_compiled_aot_file.aot
+```
+
+## Development
+You can develop your own application based on the `wamr_app_lib` APIs.
+
+### Console APIs
+``` typescript
+function log(a: string): void;
+function log_number(a: number): void;
+```
+
+### Timer APIs
+``` typescript
+function setTimeout(cb: () => void, timeout: i32): user_timer;
+function setInterval(cb: () => void, timeout: i32): user_timer;
+function timer_cancel(timer: user_timer): void;
+function timer_restart(timer: user_timer, interval: number): void;
+function now(): i32;
+
+// export to runtime
+function on_timer_callback(on_timer_id: i32): void;
+```
+
+### Request APIs
+``` typescript
+// register handler
+function register_resource_handler(url: string,
+                                   request_handle: request_handler_f): void;
+// request
+function post(url: string, payload: ArrayBuffer, payload_len: number,
+              tag: string, cb: (resp: wamr_response) => void): void;
+function get(url: string, tag: string,
+             cb: (resp: wamr_response) => void): void;
+function put(url: string, payload: ArrayBuffer, payload_len: number, tag: string,
+             cb: (resp: wamr_response) => void): void;
+function del(url: string, tag: string,
+             cb: (resp: wamr_response) => void): void;
+
+// response
+function make_response_for_request(req: wamr_request): wamr_response;
+function api_response_send(resp: wamr_response): void;
+
+// event
+function publish_event(url: string, fmt: number,
+                       payload: ArrayBuffer, payload_len: number): void;
+function subscribe_event(url: string, cb: request_handler_f): void;
+
+// export to runtime
+function on_request(buffer_offset: i32, size: i32): void;
+function on_response(buffer_offset : i32, size: i32): void;
+```
+
+You should export the `on_timer_callback`, `on_request` and `on_response` in your application entry file, refer to the samples for example.
+
+To build your application, you can use `asc`:
+``` bash
+asc app.ts -b build/app.wasm -t build/app.wat --sourceMap --validate --optimize
+```
+or you can add a command into [package.json](./package.json):
+``` json
+"build:app": "asc app.ts -b build/app.wasm -t build/app.wat --sourceMap --validate --optimize",
+```

assembly-script/package-lock.json

@@ -0,0 +1,20 @@
+{
+  "name": "assembly_script",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build:request_handler": "asc samples/request_handler.ts -b build/request_handler.wasm -t build/request_handler.wat --sourceMap --validate --optimize",
+    "build:request_sender": "asc samples/request_sender.ts -b build/request_sender.wasm -t build/request_sender.wat --sourceMap --validate --optimize",
+    "build:timer": "asc samples/timer.ts -b build/timer.wasm -t build/timer.wat --sourceMap --validate --optimize",
+    "build:publisher": "asc samples/event_publisher.ts -b build/event_publisher.wasm -t build/event_publisher.wat --sourceMap --validate --optimize",
+    "build:subscriber": "asc samples/event_subscriber.ts -b build/event_subscriber.wasm -t build/event_subscriber.wat --sourceMap --validate --optimize",
+    "build:all": "npm run build:request_handler; npm run build:request_sender; npm run build:timer; npm run build:subscriber; npm run build:publisher"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "assemblyscript": "^0.8.1"
+  }
+}

assembly-script/package.json

@@ -0,0 +1,36 @@
+/*
+ * Copyright (C) 2019 Intel Corporation.  All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+ */
+
+// The entry file of your WebAssembly module.
+import * as console from "../wamr_app_lib/console"
+import * as timer from "../wamr_app_lib/timer"
+import * as request from "../wamr_app_lib/request"
+
+function publish_overheat_event(): void {
+    var payload = String.UTF8.encode("warning: temperature is over high");
+    request.publish_event("alert/overheat", 0, payload, payload.byteLength);
+}
+
+export function on_init() : void {
+    timer.setInterval(publish_overheat_event, 2000);
+}
+
+export function on_destroy() : void {
+
+}
+
+
+/* Function below are requred by wamr runtime, don't remove or modify them */
+export function _on_timer_callback(on_timer_id: i32): void {
+    timer.on_timer_callback(on_timer_id);
+}
+
+export function _on_request(buffer_offset: i32, size: i32): void {
+    request.on_request(buffer_offset, size);
+}
+
+export function _on_response(buffer_offset : i32, size: i32): void {
+    request.on_response(buffer_offset, size);
+}

assembly-script/samples/event_publisher.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright (C) 2019 Intel Corporation.  All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+ */
+
+// The entry file of your WebAssembly module.
+import * as console from "../wamr_app_lib/console"
+import * as timer from "../wamr_app_lib/timer"
+import * as request from "../wamr_app_lib/request"
+
+export function on_init() : void {
+    request.subscribe_event("alert/overheat", (req) => {
+        console.log("### user over heat event handler called:");
+
+        console.log("");
+        console.log("    " + String.UTF8.decode(req.payload) + "\n");
+    })
+}
+
+export function on_destroy() : void {
+
+}
+
+
+/* Function below are requred by wamr runtime, don't remove or modify them */
+export function _on_timer_callback(on_timer_id: i32): void {
+    timer.on_timer_callback(on_timer_id);
+}
+
+export function _on_request(buffer_offset: i32, size: i32): void {
+    request.on_request(buffer_offset, size);
+}
+
+export function _on_response(buffer_offset : i32, size: i32): void {
+    request.on_response(buffer_offset, size);
+}

assembly-script/samples/event_subscriber.ts

@@ -0,0 +1,40 @@
+/*
+ * Copyright (C) 2019 Intel Corporation.  All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+ */
+
+ // The entry file of your WebAssembly module.
+import * as console from "../wamr_app_lib/console"
+import * as timer from "../wamr_app_lib/timer"
+import * as request from "../wamr_app_lib/request"
+
+export function on_init() : void {
+    request.register_resource_handler("/test", (req) => {
+        console.log("### Req: /test  " + String.UTF8.decode(req.payload));
+
+        console.log("    request payload:");
+        console.log("    " + String.UTF8.decode(req.payload) + "\n");
+
+        var resp = request.make_response_for_request(req);
+        resp.set_payload(String.UTF8.encode("Ok"), 2);
+        request.api_response_send(resp);
+    });
+}
+
+export function on_destroy() : void {
+
+}
+
+
+/* Function below are requred by wamr runtime, don't remove or modify them */
+export function _on_timer_callback(on_timer_id: i32): void {
+    timer.on_timer_callback(on_timer_id);
+}
+
+export function _on_request(buffer_offset: i32, size: i32): void {
+    request.on_request(buffer_offset, size);
+}
+
+export function _on_response(buffer_offset : i32, size: i32): void {
+    request.on_response(buffer_offset, size);
+}

assembly-script/samples/request_handler.ts

@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2019 Intel Corporation.  All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+ */
+
+// The entry file of your WebAssembly module.
+import * as console from "../wamr_app_lib/console"
+import * as timer from "../wamr_app_lib/timer"
+import * as request from "../wamr_app_lib/request"
+
+export function on_init() : void {
+    var payload = String.UTF8.encode("test message");
+    request.post("/test", payload, payload.byteLength, "", (resp) => {
+        if (resp != null) {
+            console.log("Post Success");
+
+            if (resp.payload != null) {
+                console.log("    response payload:")
+                console.log("    " + String.UTF8.decode(resp.payload!) + "\n");
+            }
+        }
+        else
+            console.log("Post Timeout");
+    });
+}
+
+export function on_destroy() : void {
+
+}
+
+
+/* Function below are requred by wamr runtime, don't remove or modify them */
+export function _on_timer_callback(on_timer_id: i32): void {
+    timer.on_timer_callback(on_timer_id);
+}
+
+export function _on_request(buffer_offset: i32, size: i32): void {
+    request.on_request(buffer_offset, size);
+}
+
+export function _on_response(buffer_offset : i32, size: i32): void {
+    request.on_response(buffer_offset, size);
+}

assembly-script/samples/request_sender.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright (C) 2019 Intel Corporation.  All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+ */
+
+// The entry file of your WebAssembly module.
+import * as console from '../wamr_app_lib/console'
+import * as timer from '../wamr_app_lib/timer'
+
+/* clousure is not implemented yet, we need to declare global variables
+    so that they can be accessed inside a callback function */
+var cnt = 0;
+var my_timer: timer.user_timer;
+
+export function on_init(): void {
+    /* The callback function will be called every 2 second,
+        and will stop after 10 calls */
+    my_timer = timer.setInterval(() => {
+        cnt ++;
+        console.log((cnt * 2).toString() + " seconds passed");
+
+        if (cnt >= 10) {
+            timer.timer_cancel(my_timer);
+            console.log("Stop Timer");
+        }
+    }, 2000);
+}
+
+export function on_destroy(): void {
+
+}
+
+/* Function below are requred by wamr runtime, don't remove or modify them */
+export function _on_timer_callback(on_timer_id: i32): void {
+    timer.on_timer_callback(on_timer_id);
+}

assembly-script/samples/timer.ts

@@ -0,0 +1,6 @@
+{
+  "extends": "../node_modules/assemblyscript/std/assembly.json",
+  "include": [
+    "./**/*.ts"
+  ]
+}