Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leonardpahlke/example-wasm-pointer-plugins
https://github.com/leonardpahlke/example-wasm-pointer-plugins
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/leonardpahlke/example-wasm-pointer-plugins
- Owner: leonardpahlke
- License: apache-2.0
- Created: 2024-06-02T16:30:12.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-02T16:41:23.000Z (7 months ago)
- Last Synced: 2024-11-07T22:46:50.726Z (about 2 months ago)
- Language: Rust
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# example-wasm-pointer-plugins
This example project illustrates how to start a WebAssembly (WASM) module as a plugin or extension and transfer information from the WASM module to the parent module. Given that the standard API for WASM only allows the transfer of integers, this project utilizes WASM pointers to facilitate the transfer of information.
Steps Involved:
1. **Request Data**: Initiate a request for data from the WASM module.
2. **Get WASM Pointer**: Obtain a pointer from the WASM module.
3. **Transform WASM Pointer to Regular Pointer**: Convert the WASM pointer into a regular pointer that can be used by the parent module.
4. **Read Data Transfer Object (DTO)**: The DTO holds a pointer to the value we want to read, along with the lenght of the value that is referenced (see definition below).
```rust
#[repr(C)]
#[derive(Debug)]
pub struct PluginCollectData {
pub offset: i32,
pub len: i32,
}
```
5. **Read Information from DTO Pointer**: Extract the information from the DTO pointer.
6. **Deallocate Data in WASM Memory (Depending on usecase)**: Depending on the use case, deallocate the data in WASM memory. (Note: This step is not implemented in the current version.)
### How to run:
1. `make build` to build the three applications
2. `make run` to run the App
3. `make clean` & `make clean-build` to remove any created artifacts
### References:
This project is inspired by:
- https://docs.wasmtime.dev/examples-rust-wasi.html
- https://github.com/bytecodealliance/wasmtime/blob/main/examples/fib-debug/main.rs