update readme

FastVM · Jan 9, 2023 · 70dd3e6 · 70dd3e6
1 parent 34190ac
commit 70dd3e6
Show file tree

Hide file tree

Showing 14 changed files with 70 additions and 15 deletions.
diff --git a/.github/workflows/all.yml b/.github/workflows/all.yml
@@ -11,7 +11,7 @@ jobs:
         with:
           version: 3.1.25
           actions-cache-folder: 'emsdk-cache'
-      - run: make CC=gcc OPT='-O3 -fomit-frame-pointer' all
+      - run: make CC=gcc OPT='-O3 -flto -fomit-frame-pointer' all CFLAGS+='-DWEB49_OPT_CONST0'
       - run: sudo cp bin/miniwasm /usr/bin/miniwasm
       - run: pushd ./; git clone https://github.com/wasm3/wasm3 && cd wasm3 && cmake . && sudo make -Bj install; popd
       - run: sudo apt install -y python3 python3-pip

diff --git a/README.md b/README.md
@@ -1,28 +1,83 @@
 # Web49
 
-Web49 contains a few tools for working with webassembly
+Web49 contains a few tools for working with WebAssembly.
 
-## miniwasm
+* interpreters
+    * miniwasm
+        * [fast](#benchmarks) wasm interpreter
+            * uses technology from [minivm](https://github.com/fastvm/minivm)
+        * suports multiple wasm formats
+            * wasm binary format: ~100% complete
+            * wasm text format: ~95% complete
+            * wasm spect test: ~75% complete
+        * includes a custom [WASI](https://github.com/webassembly/wasi) [implementation](src/api/wasi.c)
+    * raywasm
+        * wasm interpreter based on miniwasm
+        * includes [raylib](https://github.com/raysan5/raylib) [bindings](src/api/raylib.c) [generated from](src/api/raylib.py) [json](src/api/raylib.json)
+* wasm binary tools rewrite
+    * much simpler than WABT's tools
+    * much smaller than Binaryen's tools
+    * [wat2wasm](main/wat2wasm.c)
+        * convert wasm text into wasm binary
+    * [wasm2wat](main/wasm2wat.c)
+        * generates nearly identical wat as binaryen or wabt
+        * turn wasm binary into wasm text
+        * supports all of wasm 1.0 and some extensions
+    * [wasm2wasm](main/wasm2wasm.c)
+        * shrink numbers in wasm files generated by llvm
+            * saves 0-4 bytes per 32 bit number
+            * saves 0-10 bytes per 64 bit number
+        * round trip parse and reemit
 
-MiniWASM applies what was learned in developing MiniVM to a webassembly intepreter.
+## Benchmarks
 
-MiniVM was about 2x faster than Wasm3, with more types and more dynamism.
-MiniVM was natively a register-only machine, and MiniWASM too will be mostly registers.
+Benchmarks performed by [wasm3](https://github.com/wasm3/wasm3) and miniwasm. Ran on an 2020 Macbook Air (M1 + 8GiB ram) using [bench.py](bench.py).
 
-MiniWASM intends to support all of what people use today in webassembly, tho it is still under heavy development.
+All Benchmarks compiled with: `emcc -O2`
 
-## wasm2wat
+One can also view results run on [github actions](https://github.com/FastVM/Web49/actions)
+One can run the benchmarks for themselves.
 
-The wasm2wat tool is a faster rewrite of wabt's wasm2wat, doing only the bare minimum for now.
+* python3
+    * with pip
+* make
+    * tested with GNUMake
+    * works with BSDMake too
+* and a C compiler
+    * gcc/clang/tcc works
+    * msvc would work if someone rewrites two macros
+        * #define NEXT() break
+        * #define LABEL(X) case X:
+        * probably a couple others
 
-## wat2wasm
+```sh
+git clone https://github.com/fastvm/web49
+cd web49
+make CC=gcc # gcc is fastest in my tests
+python3 -m pip install matplotlib
+python3 bench.py
+```
 
-The wat2wasm tool is a much faster rewrite of wabt's wat2wasm, it does not handle names correctly yet.
+### [Binary Trees](test/bench/binary-trees.c)
+![](res/binary-trees.png)
 
-## wasm2wasm
+### [Coremark](test/bench/coremark.c)
+![](res/coremark.png)
 
-The wasm2wasm tool intends to do the same thing as a round trip to the text format and back. Effectivly seeing the binary as it is seen by miniwasm/wasm2wat=
+### [Fannkuch Redux](test/bench/fannkuch-redux.c)
+![](res/fannkuch-redux.png)
 
-# whoami
+### [Fibonacci on ints32_t](test/bench/fib_i32.c)
+![](res/fib_i32.png)
 
-I am Shaw Summa, of MiniVM fame.
+### [Mandelbrot with SIMD](test/bench/mandelbrot-simd.c)
+![](res/mandelbrot-simd.png)
+
+### [Mandelbrot without SIMD](test/bench/mandelbrot.c)
+![](res/mandelbrot.png)
+
+### [Nbody](test/bench/nbody.c)
+![](res/nbody.png)
+
+### [Executing A Trap](test/bench/trap.c)
+![](res/trap.png)
diff --git a/res/binary-trees.png b/res/binary-trees.png
diff --git a/res/coremark.png b/res/coremark.png
diff --git a/res/fannkuch-redux.png b/res/fannkuch-redux.png
diff --git a/res/fib_f32.png b/res/fib_f32.png
diff --git a/res/fib_f64.png b/res/fib_f64.png
diff --git a/res/fib_i32.png b/res/fib_i32.png
diff --git a/res/fib_i64.png b/res/fib_i64.png
diff --git a/res/mandelbrot-simd.png b/res/mandelbrot-simd.png
diff --git a/res/mandelbrot.png b/res/mandelbrot.png
diff --git a/res/nbody.png b/res/nbody.png
diff --git a/res/nop.png b/res/nop.png
diff --git a/res/trap.png b/res/trap.png