mirror of
https://github.com/fluencelabs/wasmer
synced 2025-03-17 16:50:48 +00:00
1142: doc(runtime-c-api) Setup Doxygen r=syrusakbary a=Hywan With @MarkMcCaskey, we discussed generating the documentation of `wasmer-runtime-c-api` with [Doxygen](http://www.doxygen.nl/). This patch does the following: 1. Set up a `doxyfile`, which is the configuration file for Doxygen. 2. Set up a `doc/header.html` and `doc/footer.html` files, because Doxygen HTML output is… well, not a master piece 😉. 3. Set up a `doc/css/wasmer.css` stylesheet. I tried to mimic Wasmer color scheme. Usually, I'm not a bad designer, but Doxygen HTML output is so “alembic-ed” that it makes customizing the CSS a real challenge for the very short period of time I've. Anyway, I believe it's an acceptable first step. To generate the documentation: ```sh $ doxygen doxyfile ``` And then open `doc/html/index.html`. It looks like this:     The next step is to publish the documentation on Github Pages, thoughts @syrusakbary? Co-authored-by: Ivan Enderlin <ivan.enderlin@hoa-project.net>
Wasmer Libraries
Wasmer is modularized into different libraries, separated into three main sections:
Runtime
The core of Wasmer is the runtime, which provides the necessary abstractions to create a good user experience when embedding.
The runtime is divided into two main libraries:
- runtime-core: The main implementation of the runtime.
- runtime: Easy-to-use API on top of
runtime-core
.
Integrations
The integration builds on the Wasmer runtime and allow us to run WebAssembly files compiled for different environments.
Wasmer intends to support different integrations:
- WASI: run WebAssembly files with the WASI ABI.
- Emscripten: run Emscripten-generated WebAssembly files, such as Lua or nginx.
- Go ABI: we will work on this soon! Want to give us a hand? ✋
- Blazor: research period, see tracking issue
Backends
The Wasmer runtime is designed to support multiple compiler backends, allowing the user to tune the codegen properties (compile speed, performance, etc) to best fit their use case.
Currently, we support multiple backends for compiling WebAssembly to machine code:
- singlepass-backend: Single pass backend - super fast compilation, slower runtime speed
- clif-backend: Cranelift backend - slower compilation, normal runtime speed
- llvm-backend: LLVM backend - slow compilation, native runtime speed