feat!: Upgrade to Binaryen v126

Full Diff: WebAssembly/binaryen@version_125...version_126

Ocaml Summary:
* `Feature.relaxed_atomics` was implented
* The following passes were added `Passes.gsi_desc_cast`, `Passes.remove_relaxed_simd`, `Passes.strip_toolchain_annotations`
* `Passes.jspi` was removed.
*  Internally `Binaryen.arrayref` was exposed directly through the js api
* Internally `module.updateMaps()` is now provided by the js api allowing us to properly handle `Module.update_maps` through jsoo compilations
Disregarded Change Summary:
* MemoryOrder was added throughout the atomics api however since we do not implement the atomics api no changes have been made to binaryen.ml
* More `TableRef` api functions were exposed through the js api however since we don't currently implement the api for tablerefs these are not being added in this pr we should open an issue before merging this to implement that api.
* `BinaryenReturnCallRef` was added to the c api along with `module.call_ref` and `module.return_call_ref` in the js api however these are being left to the gc pr
* The `Call_ref` api was imlemented however we are leaving this as well to the gc pr.

Author: spotandjake

binaryen.opam

@@ -16,6 +16,6 @@ depends: [
   "dune" {>= "3.0.0"}
   "dune-configurator" {>= "3.0.0"}
   "js_of_ocaml-compiler" {>= "6.0.0" < "7.0.0"}
-  "libbinaryen" {>= "125.0.0" < "126.0.0"}
+  "libbinaryen" {>= "126.0.0" < "127.0.0"}
 ]
 x-maintenance-intent: ["0.(latest)"]

esy.lock/index.json

@@ -6,7 +6,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "ocaml": ">= 4.13.0 < 5.4.0",
-    "@grain/libbinaryen": ">= 125.0.0 < 126.0.0",
+    "@grain/libbinaryen": ">= 126.0.0 < 127.0.0",
     "@opam/dune": ">= 3.0.0",
     "@opam/dune-configurator": ">= 3.0.0"
   },
@@ -16,7 +16,8 @@
     "@opam/ocaml-lsp-server": ">= 1.9.1 < 2.0.0"
   },
   "resolutions": {
-    "@opam/ocp-indent": "1.7.0"
+    "@opam/ocp-indent": "1.7.0",
+    "@grain/libbinaryen": "git+https://www.github.com/spotandjake/libbinaryen.git#c596fe826ccb9edd91e060becb6284a2d429ea6d"
   },
   "esy": {
     "build": "dune build -p binaryen"

package.json

@@ -132,6 +132,5 @@ function caml_binaryen_add_custom_section(wasm_mod, name, contents) {
 
 //Provides: caml_binaryen_module_update_maps
 function caml_binaryen_module_update_maps(wasm_mod) {
-  // The JS version doesn't expose `update_maps`
-  return;
+  return wasm_mod.updateMaps();
 }

src/module.js

@@ -98,6 +98,10 @@ module Feature = struct
 
   let call_indirect_overlong = call_indirect_overlong ()
 
+  external relaxed_atomics : unit -> t = "caml_binaryen_feature_relaxed_atomics"
+
+  let relaxed_atomics = relaxed_atomics ()
+
   external all : unit -> t = "caml_binaryen_feature_all"
 
   let all = all ()

src/module.ml

@@ -25,6 +25,7 @@ module Feature : sig
   val fp16 : t
   val bulk_memory_opt : t
   val call_indirect_overlong : t
+  val relaxed_atomics : t
   val all : t
 end
 

src/module.mli

@@ -155,6 +155,12 @@ caml_binaryen_feature_call_indirect_overlong(value unit) {
   CAMLreturn(Val_int(BinaryenFeatureCallIndirectOverlong()));
 }
 
+CAMLprim value
+caml_binaryen_feature_relaxed_atomics(value unit) {
+  CAMLparam1(unit);
+  CAMLreturn(Val_int(BinaryenFeatureRelaxedAtomics()));
+}
+
 CAMLprim value
 caml_binaryen_feature_all(value unit) {
   CAMLparam1(unit);

src/module_feature.c

@@ -140,6 +140,12 @@ function caml_binaryen_feature_call_indirect_overlong() {
   return Binaryen.Features.BulkMemoryOpt;
 }
 
+//Provides: caml_binaryen_feature_relaxed_atomics
+//Requires: Binaryen
+function caml_binaryen_feature_relaxed_atomics() {
+  return Binaryen.Features.RelaxedAtomics;
+}
+
 //Provides: caml_binaryen_feature_all
 //Requires: Binaryen
 function caml_binaryen_feature_all() {

src/module_feature.js

@@ -106,6 +106,9 @@ let generate_global_effects = "generate-global-effects"
 (** refine the types of globals *)
 let global_refining = "global-refining"
 
+(** globally optimize struct values, also emitting ref.cast_desc_eq *)
+let gsi_desc_cast = "gsi-desc-cast"
+
 (** globally optimize struct values *)
 let gsi = "gsi"
 
@@ -152,9 +155,6 @@ let inlining_optimizing = "inlining-optimizing"
 (** lower away binaryen intrinsics *)
 let intrinsic_lowering = "intrinsic-lowering"
 
-(** wrap imports and exports for JavaScript promise integration *)
-let jspi = "jspi"
-
 (** legalizes i64 types on the import/export boundary *)
 let legalize_js_interface = "legalize-js-interface"
 
@@ -321,6 +321,9 @@ let symbolmap = "symbolmap"
 (** removes operations incompatible with js *)
 let remove_non_js_ops = "remove-non-js-ops"
 
+(** replaces relaxed SIMD instructions with unreachable *)
+let remove_relaxed_simd = "remove-relaxed-simd"
+
 (** removes imports and replaces them with nops *)
 let remove_imports = "remove-imports"
 
@@ -468,6 +471,9 @@ let strip_eh = "strip-eh"
 (** strip the wasm target features section *)
 let strip_target_features = "strip-target-features"
 
+(** strip all toolchain-specific code annotations *)
+let strip_toolchain_annotations = "strip-toolchain-annotations"
+
 (** translate old Phase 3 EH instructions to new ones with exnref *)
 let translate_to_exnref = "translate-to-exnref"
 
@@ -486,7 +492,7 @@ let type_finalizing = "type-finalizing"
 (** merge types to their supertypes where possible *)
 let type_merging = "type-merging"
 
-(** create new nominal types to help other optimizations *)
+(** create new types to help other optimizations *)
 let type_ssa = "type-ssa"
 
 (** mark all types as non-final (open) *)

src/passes.ml

@@ -106,6 +106,9 @@ val generate_global_effects : t
 val global_refining : t
 (** refine the types of globals *)
 
+val gsi_desc_cast : t
+(** globally optimize struct values, also emitting ref.cast_desc_eq *)
+
 val gsi : t
 (** globally optimize struct values *)
 
@@ -149,9 +152,6 @@ val inlining_optimizing : t
 val intrinsic_lowering : t
 (** lower away binaryen intrinsics *)
 
-val jspi : t
-(** wrap imports and exports for JavaScript promise integration *)
-
 val legalize_js_interface : t
 (** legalizes i64 types on the import/export boundary *)
 
@@ -316,6 +316,9 @@ val symbolmap : t
 val remove_non_js_ops : t
 (** removes operations incompatible with js *)
 
+val remove_relaxed_simd : t
+(** replaces relaxed SIMD instructions with unreachable *)
+
 val remove_imports : t
 (** removes imports and replaces them with nops *)
 
@@ -352,7 +355,7 @@ val reorder_globals : t
 val reorder_locals : t
 (** sorts locals by access frequency *)
 
-val reorder_types: t
+val reorder_types : t
 (** sorts private types by access frequency *)
 
 val rereloop : t
@@ -460,6 +463,9 @@ val strip_eh : t
 val strip_target_features : t
 (** strip the wasm target features section *)
 
+val strip_toolchain_annotations : t
+(** strip all toolchain-specific code annotations *)
+
 val translate_to_exnref : t
 (** translate old Phase 3 EH instructions to new ones with exnref *)
 
@@ -479,7 +485,7 @@ val type_merging : t
 (** merge types to their supertypes where possible *)
 
 val type_ssa : t
-(** create new nominal types to help other optimizations *)
+(** create new types to help other optimizations *)
 
 val type_unfinalizing : t
 (** mark all types as non-final (open) *)