Merge wasm_of_ocaml

.git-blame-ignore-revs

@@ -4,3 +4,8 @@
 7de742a776fcdad4b098695617b9e7afab822c82
 # Biome
 5a78e2466221c91fc3607be5b6549797551de4d1
+# Wasm_of_ocaml: renamed files
+02b848f0dae1924326aceb5e2b689eb4870b9e0c
+f51c956d4294c55b45a05fa6520cb5cdc9e2ade3
+40f4d4e4034d8fd21e28d74e5ff127dcd3fec37d
+a1d6554ea9d055f817edea5d32e485d836001cb3

.gitattributes

@@ -1,2 +1,6 @@
 *.ml linguist-language=OCaml
 *.mli linguist-language=OCaml
+
+# We are pinning wasm_of_ocaml using this file in the CI. This would
+# fail on Windows otherwise.
+VERSION -text

.github/workflows/build-wasm_of_ocaml.yml

@@ -0,0 +1,150 @@
+name: Build wasm_of_ocaml
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    env:
+      OPAMJOBS: 2
+      OPAMYES: true
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+        ocaml-compiler:
+          - 4.14.x
+          - 5.00.x
+          - 5.01.x
+          - 5.02.x
+          - ocaml-compiler.5.3.0~beta2
+        separate_compilation:
+          - true
+        include:
+          - os: macos-latest
+            ocaml-compiler: 5.02.x
+            separate_compilation: true
+          - os: ubuntu-latest
+            ocaml-compiler: 4.14.x
+            separate_compilation: false
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Set git to use LF
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
+          git config --global core.ignorecase false
+
+      - name: Install node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 23
+
+      - name: Install OCaml ${{ matrix.ocaml-compiler }}
+        uses: ocaml/setup-ocaml@v3
+        with:
+          ocaml-compiler: ${{ matrix.ocaml-compiler }}
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          path: wasm_of_ocaml
+
+      - name: Set-up Binaryen
+        uses: Aandreba/[email protected]
+        with:
+         version: 118
+         token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Pin faked binaryen-bin package
+        # It's faster to use a cached version
+        run: opam install --fake binaryen-bin
+
+      - name: Checkout Jane Street opam repository
+        uses: actions/checkout@v4
+        with:
+          repository: janestreet/opam-repository
+          ref: feaf8f831051fd5f316963b28efd728cf0b0eca1
+          path: jane-street/opam-repository
+
+      - name: Pin wasm_of_ocaml
+        working-directory: ./wasm_of_ocaml
+        run: opam pin -n --with-version `< VERSION` .
+
+      - name: Install some needed packages
+        run: opam install opam-format ocamlfind dune graphics cmdliner sexplib0.v0.16.0
+
+      - name: Checkout Jane Street packages
+        run: opam exec -- ocaml wasm_of_ocaml/tools/ci_setup.ml
+
+      - name: Install wasm_of_ocaml and its test dependencies
+        working-directory: ./wasm_of_ocaml
+        run: |
+          opam install `basename -s .opam *.opam` num cohttp-lwt-unix ppx_expect cstruct
+
+      - name: Run tests
+        if: ${{ matrix.separate_compilation }}
+        working-directory: ./wasm_of_ocaml
+        run: opam exec -- dune build @all @runtest --profile wasm
+
+      - name: Run tests with CPS effects
+        if: ${{ matrix.ocaml-compiler >= '5.' && matrix.separate_compilation }}
+        working-directory: ./wasm_of_ocaml
+        run: opam exec -- dune build @all @runtest --profile wasm-effects
+
+      - name: Run Base tests
+        if: ${{ matrix.ocaml-compiler < '5.' && matrix.separate_compilation }}
+        working-directory: ./jane-street/lib/base
+        run: opam exec -- dune runtest
+
+      - name: Run Base bigstring tests
+        if: ${{ matrix.ocaml-compiler < '5.' && matrix.separate_compilation }}
+        working-directory: ./jane-street/lib/base_bigstring
+        run: opam exec -- dune runtest
+
+      - name: Run Core tests
+        if: ${{ matrix.ocaml-compiler < '5.' && matrix.separate_compilation }}
+        working-directory: ./jane-street/lib/core
+        run: opam exec -- dune runtest
+
+      - name: Run Bignum tests
+        if: ${{ matrix.ocaml-compiler < '5.' && matrix.separate_compilation }}
+        working-directory: ./jane-street/lib/bignum
+        run: opam exec -- dune runtest
+
+      - name: Run Bin_prot tests
+        if: ${{ matrix.ocaml-compiler < '5.' && matrix.separate_compilation }}
+        working-directory: ./jane-street/lib/bin_prot
+        run: opam exec -- dune runtest
+
+      - name: Run String_dict tests
+        if: ${{ matrix.ocaml-compiler < '5.' && matrix.separate_compilation }}
+        working-directory: ./jane-street/lib/string_dict
+        run: opam exec -- dune runtest
+
+      - name: Run Zarith tests
+        if: ${{ matrix.ocaml-compiler < '5.' && matrix.separate_compilation }}
+        working-directory: ./jane-street/lib/zarith_stubs_js
+        run: opam exec -- dune runtest
+
+      - name: Run Virtual_dom tests
+        if: ${{ matrix.ocaml-compiler < '5.' && matrix.separate_compilation }}
+        working-directory: ./jane-street/lib/virtual_dom
+        run: opam exec -- dune runtest
+
+      - name: Run Bonsai tests
+        if: ${{ matrix.ocaml-compiler < '5.' && matrix.separate_compilation }}
+        working-directory: ./jane-street/lib/bonsai
+        run: opam exec -- dune runtest
+
+      - name: Run Bonsai tests (release profile)
+        if: ${{ ! matrix.separate_compilation }}
+        working-directory: ./jane-street/lib/bonsai
+        run: opam exec -- dune runtest --profile release

.github/workflows/build.yml

@@ -115,10 +115,29 @@ jobs:
       - run: opam install conf-pkg-config
         if: runner.os == 'Windows'
 
+      - name: Set-up Binaryen
+        uses: Aandreba/[email protected]
+        with:
+         version: 118
+         token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install faked binaryen-bin package
+        # It's faster to use a cached version
+        run: opam install --fake binaryen-bin
+
       - run: opam install . --best-effort
         if: ${{ matrix.skip-test }}
 
-      - run: opam install . --with-test
+      - run: cat VERSION | xargs opam pin . -n --with-version
+        if: ${{ !matrix.skip-test }}
+        shell: bash
+
+      - run: opam install . --with-test --deps-only
+        # Install the test dependencies
+        if: ${{ !matrix.skip-test }}
+
+      - run: opam install .
+        # Install the packages (without running the tests)
         if: ${{ !matrix.skip-test }}
 
       - run: opam exec -- make all
@@ -146,4 +165,4 @@ jobs:
           branch: wikidoc
           folder: doc-dev
           clean: true
-          target-folder: doc/dev/
+          target-folder: doc/dev/

CHANGES.md

@@ -3,6 +3,7 @@
 ## Features/Changes
 * Lib: fix the type of some DOM properties and methods (#1747)
 * Test: use dune test stanzas (#1631)
+* Merged Wasm_of_ocaml (#1724)
 
 # 5.9.1 (02-12-2024) - Lille
 

README_wasm_of_ocaml.md

@@ -0,0 +1,68 @@
+# Wasm_of_ocaml
+
+Wasm_of_ocaml is a fork of Js_of_ocaml which compiles OCaml bytecode to WebAssembly.
+
+## Supported engines
+
+The generated code works with Chrome 11.9, Node.js 22 and Firefox 122 (or more recent versions of these applications).
+
+In particular, the output code requires the following [Wasm extensions](https://webassembly.org/roadmap/) to run:
+- [the GC extension](https://github.com/WebAssembly/gc), including functional references and 31-bit integers
+- [the tail-call extension](https://github.com/WebAssembly/tail-call/blob/main/proposals/tail-call/Overview.md)
+- [the exception handling extension](https://github.com/WebAssembly/exception-handling/blob/master/proposals/exception-handling/Exceptions.md)
+
+OCaml 5.x code using effect handlers can be compiled in two different ways:
+One can enable the CPS transformation from `js_of_ocaml` by passing the
+`--enable=effects` flag. Without the flag `wasm_of_ocaml` will instead emit code
+utilizing
+- [the JavaScript-Promise Integration extension](https://github.com/WebAssembly/js-promise-integration/blob/main/proposals/js-promise-integration/Overview.md)
+
+
+## Installation
+
+The following commands will perform a minimal installation:
+```
+git clone https://github.com/ocaml-wasm/wasm_of_ocaml
+cd wasm_of_ocaml
+opam pin add -n --with-version 6.0.0 .
+opam install dune.3.17.0 wasm_of_ocaml-compiler
+```
+You may want to install additional packages. For instance:
+
+```
+opam install js_of_ocaml-ppx js_of_ocaml-lwt
+```
+
+## Usage
+
+You can try compiling the program in `examples/cubes`. Your program must first be compiled using the OCaml bytecode compiler `ocamlc`. JavaScript bindings are provided by the `js_of_ocaml` package. The syntax extension is provided by `js_of_ocaml-ppx` package. Package `js_of_ocaml-lwt` provides Javascript specific Lwt functions.
+
+```
+ocamlfind ocamlc -package js_of_ocaml,js_of_ocaml-ppx,js_of_ocaml-lwt -linkpkg -o cubes.byte cubes.mli cubes.ml
+```
+
+Then, run the `wasm_of_ocaml` compiler to produce WebAssembly code:
+
+```
+wasm_of_ocaml cubes.byte
+```
+
+This outputs a file `cubes.js` which loads the WebAssembly code from file `cube.wasm`. For debugging, we currently also output the generated WebAssembly code in text file to `cube.wat`. Since Chrome does not allow loading from the filesystem, you need to serve the files using some Web server. For instance:
+```
+python3 -m http.server 8000 --directory .
+```
+
+As a larger example, you can try [CAMLBOY](https://github.com/linoscope/CAMLBOY). You need to install a forked version of [Brr](https://github.com/ocaml-wasm/brr/tree/wasm). Once the Js_of_ocaml UI is compiled (with `dune build --profile release`), you can generate WebAssembly code instead with the following command:
+```
+wasm_of_ocaml _build/default/bin/web/index.bc-for-jsoo
+```
+
+## Implementation status
+
+A large part of the runtime is [implemented](https://github.com/ocaml-wasm/wasm_of_ocaml/issues/5). File-related functions and dynamic linking are not supported yet.
+
+## Compatibility with Js_of_ocaml
+
+Since the value representation is different, some adaptations are necessary.
+
+The most notable change is that, except for integers, OCaml numbers are no longer mapped to JavaScript numbers. So, explicit conversions `Js.to_float` and `Js.float` are now necessary to convert between OCaml floats and JavaScript numbers. The typing of JavaScript Typed Arrays has also been changed to deal with this.

compiler/bin-wasm_of_ocaml/build_runtime.ml

@@ -0,0 +1,29 @@
+(* Wasm_of_ocaml compiler
+ * http://www.ocsigen.org/js_of_ocaml/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, with linking exception;
+ * either version 2.1 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *)
+
+open! Js_of_ocaml_compiler.Stdlib
+
+let info =
+  Info.make
+    ~name:"build-runtime"
+    ~doc:"Build standalone runtime. Used for separate compilation."
+    ~description:"Wasm_of_ocaml is a compiler from OCaml bytecode to WebAssembly."
+
+let command =
+  let t = Cmdliner.Term.(const Compile.run $ Cmd_arg.options_runtime_only) in
+  Cmdliner.Cmd.v info t

compiler/bin-wasm_of_ocaml/build_runtime.mli

@@ -0,0 +1,19 @@
+(* Wasm_of_ocaml compiler
+ * http://www.ocsigen.org/js_of_ocaml/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, with linking exception;
+ * either version 2.1 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *)
+
+val command : unit Cmdliner.Cmd.t