Adapt JSOO rules for new --effects= option #11222

OlivierNicole · 2024-12-17T15:22:00Z

This takes into account the new js_of_ocaml --effects={cps,double-translation} flag, introduced in ocsigen/js_of_ocaml#1461.

hhugo · 2024-12-17T19:58:09Z

src/dune_rules/jsoo/jsoo_rules.ml

+    List.filter_opt
+      [ (match t.toplevel with Some true -> Some "--toplevel" | _ -> None)
+      ; (match t.effects with
+         | Some backend -> Some ("--effects=" ^ string_of_effects backend) | None -> None)


I think we need to remember if effect was set with --enable effects and use the same flag here otherwise we loose backward compatibility.

I would select the flags based on jsoo version:

let to_flag ~recent = [...] | Some backend -> Some (if recent then "--effects=" ^ string_of_effects backend else "--enable=effects") | None -> None) [...]

OlivierNicole · 2024-12-19T13:36:07Z

Note: I have used failwith when a dune rule is asking to pass --effects=double-translation with a version of jsoo/wasmoo that doesn’t support it, because I don’t know what the proper way of erroring in this code path is.

vouillon · 2024-12-19T14:04:10Z

Note: I have used failwith when a dune rule is asking to pass --effects=double-translation with a version of jsoo/wasmoo that doesn’t support it, because I don’t know what the proper way of erroring in this code path is.

I think you can just use --enable=effects in that case, and let the invocations of js_of_ocaml --effects=double-translation fail.

Signed-off-by: Olivier Nicole <olivier@chnik.fr>

OlivierNicole · 2024-12-20T10:53:15Z

I’m not sure to understand where the last CI failure comes from.

vouillon · 2024-12-20T11:57:17Z

src/dune_rules/jsoo/jsoo_rules.ml

+        | None, None -> set acc name `True
+        | None, Some backend ->
+          (match effects_of_string backend with
+           | Some backend -> set acc name (`Effects backend)


name is not right.

Suggested change

| Some backend -> set acc name (`Effects backend)

| Some backend -> set acc "effects" (`Effects backend)

or

Suggested change

| Some backend -> set acc name (`Effects backend)

| Some backend -> { acc with effects = Some backend }

vouillon · 2024-12-20T11:58:46Z

src/dune_rules/jsoo/jsoo_rules.ml

+module Version = struct
+  type t = int * int
+
+  let of_string s : t option =
+    let s =
+      match
+        String.findi s ~f:(function
+          | '+' | '-' | '~' -> true
+          | _ -> false)
+      with
+      | None -> s
+      | Some i -> String.take s i
+    in
+    try
+      match String.split s ~on:'.' with
+      | [] -> None
+      | [ major ] -> Some (int_of_string major, 0)
+      | major :: minor :: _ -> Some (int_of_string major, int_of_string minor)
+    with
+    | _ -> None
+  ;;
+
+  let compare (ma1, mi1) (ma2, mi2) =
+    match Int.compare ma1 ma2 with
+    | Eq -> Int.compare mi1 mi2
+    | n -> n
+  ;;
+
+  let impl_version bin =
+    let* _ = Build_system.build_file bin in
+    Memo.of_reproducible_fiber
+    @@ Process.run_capture_line ~display:Quiet Strict bin [ "--version" ]
+    |> Memo.map ~f:of_string
+  ;;
+
+  let version_memo = Memo.create "jsoo-version" ~input:(module Path) impl_version
+
+  let jsoo_version jsoo =
+    match jsoo with
+    | Ok jsoo_path -> Memo.exec version_memo jsoo_path
+    | Error e -> Action.Prog.Not_found.raise e
+  ;;
+end
+
+let install_jsoo_hint = "opam install js_of_ocaml-compiler"
+
+let jsoo ~dir sctx =
+  Super_context.resolve_program
+    sctx
+    ~dir
+    ~loc:None
+    ~where:Original_path
+    ~hint:install_jsoo_hint
+    "js_of_ocaml"
+;;
+


You don't need to move this.

hhugo · 2024-12-20T12:11:20Z

src/dune_rules/jsoo/jsoo_rules.ml

+
+  let effects_of_string = function
+    | "cps" -> Some Cps
+    | "double-translation" -> Some Cps


This isn't right

Signed-off-by: Olivier Nicole <olivier@chnik.fr>

vouillon · 2024-12-20T14:07:33Z

src/dune_rules/jsoo/jsoo_rules.ml

 end = struct
+  type effects_backend =
+    | Cps
+    | Double_translation


Maybe we should add Native and JSPI so that we don't have to modify dune if we add support for native effects in wasm_of_ocaml.

So dune would support an --effects=native flag for wasm_of_ocaml which may one day be supported by wsoo itself?

The downside is that it increases the number of dune rules registered in dune. One rule per lib per config in Config.all. We currently have 27 config on master. Having cps, double_translate, jspi, and native (what is native btw ?) and "none" would result in 45 configs. I really which we eventually come up with a better design with lazy loading of rules. That would unblock #7389.

We can wait, then.

There is a proposal to add stack switching instructions in Wasm. I started to write a implementation of effect handlers based on this proposal. There is some experiments in some Wasm engines (Wasmtime, for instance), but not yet in V8.

hhugo · 2024-12-20T15:02:37Z

src/dune_rules/jsoo/jsoo_rules.ml

+              let* jsoo = jsoo in
+              Action_builder.of_memo (Version.jsoo_version jsoo)
+            in
+            let recent =


The name recent does not say much . I think I would rather pass the version down and compare against it when needed.

vouillon · 2024-12-20T15:08:06Z

src/dune_rules/jsoo/jsoo_rules.ml

+    match name, v with
+    | "use-js-string", `True -> { acc with js_string = Some true }
+    | "use-js-string", `False -> { acc with js_string = Some false }
+    | "effects", `Effects backend -> { acc with effects = Some backend }
+    | "effects", `False ->
+      (* [--disable effects] *)
+      { acc with effects = None }
+    | "effects", `True ->
+      (* [--enable effects], used alone, implies [--effects=cps] *)
+      (match acc.effects with
+       | None -> { acc with effects = Some Cps }
+       | Some _ -> acc)
+    | "toplevel", `True -> { acc with toplevel = Some true }
+    | "toplevel", `False -> { acc with toplevel = Some false }


It would be simpler to have two set functions. One for --enable/--disable and one for --effects.

OlivierNicole mentioned this pull request Dec 17, 2024

Effects: double translation of functions and dynamic switching between direct-style and CPS code ocsigen/js_of_ocaml#1461

Open

hhugo added the jsoo label Dec 17, 2024

hhugo reviewed Dec 17, 2024

View reviewed changes

OlivierNicole force-pushed the jsoo-effects branch 3 times, most recently from 9501684 to 00390c3 Compare December 20, 2024 10:31

OlivierNicole added 5 commits December 20, 2024 11:46

Adapt JSOO rules for new --effects= option

d702661

Signed-off-by: Olivier Nicole <olivier@chnik.fr>

Make the rules compatible with pre-6.0 jsoo

bf15763

Signed-off-by: Olivier Nicole <olivier@chnik.fr>

CR

4008d0c

Signed-off-by: Olivier Nicole <olivier@chnik.fr>

reformat

e2ea325

Signed-off-by: Olivier Nicole <olivier@chnik.fr>

Fix test: rule evaluation order

1ec1bd3

Signed-off-by: Olivier Nicole <olivier@chnik.fr>

OlivierNicole force-pushed the jsoo-effects branch from 00390c3 to 1ec1bd3 Compare December 20, 2024 11:26

vouillon reviewed Dec 20, 2024

View reviewed changes

hhugo reviewed Dec 20, 2024

View reviewed changes

OlivierNicole marked this pull request as ready for review December 20, 2024 14:04

OlivierNicole added 2 commits December 20, 2024 15:04

CR: bugs

19e12d4

Signed-off-by: Olivier Nicole <olivier@chnik.fr>

CR: revert unnecessary moving of code

88be4f4

Signed-off-by: Olivier Nicole <olivier@chnik.fr>

OlivierNicole force-pushed the jsoo-effects branch from 76cc225 to 88be4f4 Compare December 20, 2024 14:05

vouillon reviewed Dec 20, 2024

View reviewed changes

hhugo reviewed Dec 20, 2024

View reviewed changes

vouillon reviewed Dec 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adapt JSOO rules for new --effects= option #11222

Adapt JSOO rules for new --effects= option #11222

OlivierNicole commented Dec 17, 2024

hhugo Dec 17, 2024

vouillon Dec 18, 2024

OlivierNicole Dec 19, 2024

OlivierNicole commented Dec 19, 2024

vouillon commented Dec 19, 2024

OlivierNicole commented Dec 20, 2024

vouillon Dec 20, 2024

vouillon Dec 20, 2024

hhugo Dec 20, 2024

vouillon Dec 20, 2024

OlivierNicole Dec 20, 2024

vouillon Dec 20, 2024

hhugo Dec 20, 2024

vouillon Dec 20, 2024

hhugo Dec 20, 2024

vouillon Dec 20, 2024

	\| Some backend -> set acc name (`Effects backend)
	\| Some backend -> set acc "effects" (`Effects backend)

	\| Some backend -> set acc name (`Effects backend)
	\| Some backend -> { acc with effects = Some backend }

Adapt JSOO rules for new --effects= option #11222

Are you sure you want to change the base?

Adapt JSOO rules for new --effects= option #11222

Conversation

OlivierNicole commented Dec 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OlivierNicole commented Dec 19, 2024

vouillon commented Dec 19, 2024

OlivierNicole commented Dec 20, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment