Merge branch 'main' into lambda-layout

Author: Ekdohibs

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
         "ocaml.sandbox": {
                 "kind": "opam",
-                "switch": "4.14.0"
+                "switch": "4.14.1"
         }
 }

HACKING.md

@@ -3,22 +3,23 @@
 This page is intended to keep track of useful information for people who
 want to modify the Flambda backend.  Jump to:
 
-  - [Branches, pull requests, etc.](#branches-pull-requests-etc)
-  - [Upstream subtree](#upstream-subtree)
-  - [Code formatting](#code-formatting)
-  - [Rebuilding during dev work](#rebuilding-during-dev-work)
-  - [Running tests](#running-tests)
-  - [Running only part of the upstream testsuite](#running-only-part-of-the-upstream-testsuite)
-  - [Running tests with coverage analysis](#running-tests-with-coverage-analysis)
-  - [Running the compiler produced by "make hacking" on an example without the stdlib](#running-the-compiler-produced-by-make-hacking-on-an-example-without-the-stdlib)
-  - [Getting the compilation command for a stdlib file](#getting-the-compilation-command-for-a-stdlib-file)
-  - [Bootstrapping the ocaml subtree](#bootstrapping-the-ocaml-subtree)
-  - [Testing the compiler built locally with OPAM](#testing-the-compiler-built-locally-with-opam)
-  - [Pulling changes onto a release branch](#pulling-changes-onto-a-release-branch)
-  - [Rebasing to a new major version of the upstream compiler](#rebasing-to-a-new-major-version-of-the-upstream-compiler)
-  - [How to add a new intrinsic to the compiler](#how-to-add-a-new-intrinsic-to-the-compiler)
-  - [How to add a new command line option](#how-to-add-a-new-command-line-option)
-  - [Installation tree comparison script](#installation-tree-comparison-script)
+- [Branches, pull requests, etc.](#branches-pull-requests-etc)
+- [Upstream subtree](#upstream-subtree)
+- [Code formatting](#code-formatting)
+- [Rebuilding during dev work](#rebuilding-during-dev-work)
+- [Updating magic numbers](#updating-magic-numbers)
+- [Running tests](#running-tests)
+- [Running only part of the upstream testsuite](#running-only-part-of-the-upstream-testsuite)
+- [Running tests with coverage analysis](#running-tests-with-coverage-analysis)
+- [Running the compiler produced by "make hacking" on an example without the stdlib](#running-the-compiler-produced-by-make-hacking-on-an-example-without-the-stdlib)
+- [Getting the compilation command for a stdlib file](#getting-the-compilation-command-for-a-stdlib-file)
+- [Bootstrapping the ocaml subtree](#bootstrapping-the-ocaml-subtree)
+- [Testing the compiler built locally with OPAM](#testing-the-compiler-built-locally-with-opam)
+- [Pulling changes onto a release branch](#pulling-changes-onto-a-release-branch)
+- [Rebasing to a new major version of the upstream compiler](#rebasing-to-a-new-major-version-of-the-upstream-compiler)
+- [How to add a new intrinsic to the compiler](#how-to-add-a-new-intrinsic-to-the-compiler)
+- [How to add a new command line option](#how-to-add-a-new-command-line-option)
+- [Installation tree comparison script](#installation-tree-comparison-script)
 
 ## Branches, pull requests, etc.
 
@@ -112,6 +113,22 @@ Any changes in `ocaml/asmcomp` and `ocaml/middle_end` directories
 should also be applied to the corresponding directories `backend` and
 `middle_end`.
 
+## Updating magic numbers
+
+Start from a completely clean tree.  Then change into the `ocaml` subdirectory
+and proceed as follows:
+```
+./configure
+make coldstart
+make coreall
+```
+Then edit `runtime/exec.h` and `utils/config.mlp` to bump the numbers.  Then:
+```
+make coreall
+make bootstrap
+```
+and commit the result.
+
 ## Running tests
 
 Prior to `make install` you can do:

Makefile

@@ -93,6 +93,7 @@ fmt:
 	  $$(find backend/debug \
 	    \( -name "*.ml" -or -name "*.mli" \))
 	ocamlformat -i backend/cmm_helpers.ml{,i}
+	ocamlformat -i backend/cmm_builtins.ml{,i}
 	ocamlformat -i backend/checkmach.ml{,i}
 	ocamlformat -i tools/merge_archives.ml
 	ocamlformat -i \
@@ -101,6 +102,9 @@ fmt:
 	ocamlformat -i \
 	  $$(find utils \
 	    \( -name "*.ml" -or -name "*.mli" \))
+	ocamlformat -i \
+	  $$(find ocaml/utils \
+	    \( -name "*.ml" -or -name "*.mli" \))
 
 .PHONY: check-fmt
 check-fmt:
@@ -111,8 +115,10 @@ check-fmt:
            [ "$$(git status --porcelain backend/asm_targets)" != "" ] || \
            [ "$$(git status --porcelain backend/debug)" != "" ] || \
            [ "$$(git status --porcelain backend/cmm_helpers.ml{,i})" != "" ] || \
+           [ "$$(git status --porcelain backend/cmm_builtins.ml{,i})" != "" ] || \
            [ "$$(git status --porcelain backend/checkmach.ml{,i})" != "" ] || \
            [ "$$(git status --porcelain tools/merge_archives.ml)" != "" ] || \
+           [ "$$(git status --porcelain ocaml/utils)" != "" ] || \
            [ "$$(git status --porcelain utils)" != "" ]; then \
 	  echo; \
 	  echo "Tree must be clean before running 'make check-fmt'"; \
@@ -126,8 +132,10 @@ check-fmt:
            [ "$$(git diff backend/asm_targets)" != "" ] || \
            [ "$$(git diff backend/debug)" != "" ] || \
            [ "$$(git diff backend/cmm_helpers.ml{,i})" != "" ] || \
+           [ "$$(git diff backend/cmm_builtins.ml{,i})" != "" ] || \
            [ "$$(git diff backend/checkmach.ml{,i})" != "" ] || \
            [ "$$(git diff tools/merge_archives.ml)" != "" ] || \
+           [ "$$(git diff ocaml/utils)" != "" ] || \
            [ "$$(git diff utils)" != "" ]; then \
 	  echo; \
 	  echo "The following code was not formatted correctly:"; \

backend/.ocamlformat-enable

@@ -1,5 +1,7 @@
 cmm_helpers.ml
 cmm_helpers.mli
+cmm_builtins.ml
+cmm_builtins.mli
 internal_assembler/*.ml
 internal_assembler/*.mli
 checkmach.ml

backend/amd64/emit.mlp

@@ -361,6 +361,52 @@ let emit_call_bound_errors () =
     emit_call "caml_ml_array_bound_error"
   end
 
+(* Record function info for dwarf and emit label if needed. *)
+let emit_dwarf_for_fundecl fun_name fun_dbg =
+  match Emitaux.Dwarf_helpers.record_dwarf_for_fundecl ~fun_name fun_dbg with
+  | None -> ()
+  | Some label -> def_label label
+
+let build_asm_directives () : (module Asm_targets.Asm_directives_intf.S) = (
+    module Asm_targets.Asm_directives.Make(struct
+
+      let emit_line str = X86_dsl.D.comment str
+
+      let get_file_num file_name =
+        Emitaux.get_file_num ~file_emitter:X86_dsl.D.file file_name
+
+      let debugging_comments_in_asm_files =
+        !Flambda_backend_flags.dasm_comments
+
+      module D = struct
+        open X86_ast
+
+        include X86_dsl.D
+
+        type data_type =
+          | NONE | DWORD | QWORD
+
+        type nonrec constant = constant
+        let const_int64 num = Const num
+        let const_label str = ConstLabel str
+        let const_add c1 c2 = ConstAdd (c1, c2)
+        let const_sub c1 c2 = ConstSub (c1, c2)
+
+        let label ?data_type str =
+          let typ =
+            Option.map
+              (function
+                | NONE -> X86_ast.NONE
+                | DWORD -> X86_ast.DWORD
+                | QWORD -> X86_ast.QWORD)
+              data_type
+          in
+          label ?typ str
+      end
+    end)
+  )
+
+
 (* Names for instructions *)
 
 let instr_for_intop = function
@@ -525,13 +571,16 @@ let emit_float_constant f lbl =
   _label (emit_label lbl);
   D.qword (Const f)
 
-let emit_global_label s =
-  let lbl = Cmm_helpers.make_symbol s in
+let emit_global_label_for_symbol lbl =
   add_def_symbol lbl;
   let lbl = emit_symbol lbl in
   D.global lbl;
   _label lbl
 
+let emit_global_label s =
+  let lbl = Cmm_helpers.make_symbol s in
+  emit_global_label_for_symbol lbl
+
 let move (src : Reg.t) (dst : Reg.t) =
   if src.loc <> dst.loc then
     begin match src.typ, src.loc, dst.typ, dst.loc with
@@ -1303,7 +1352,7 @@ let fundecl fundecl =
       cfi_adjust_cfa_offset (-n);
     end;
   end;
-  def_label fundecl.fun_end_label;
+  emit_dwarf_for_fundecl fundecl.fun_name fundecl.fun_dbg;
   cfi_endproc ();
   emit_function_type_and_size fundecl.fun_name
 
@@ -1341,10 +1390,17 @@ let reset_all () =
   float_constants := [];
   all_functions := []
 
-let begin_assembly ~init_dwarf =
+let begin_assembly unix =
   reset_all ();
 
-  init_dwarf ();
+  if !Flambda_backend_flags.internal_assembler &&
+     !Emitaux.binary_backend_available then
+    X86_proc.register_internal_assembler (Internal_assembler.assemble unix);
+
+  let code_begin = Cmm_helpers.make_symbol "code_begin" in
+  let code_end = Cmm_helpers.make_symbol "code_end" in
+  Emitaux.Dwarf_helpers.begin_dwarf ~build_asm_directives ~code_begin ~code_end
+    ~file_emitter:D.file;
 
   if system = S_win64 then begin
     D.extrn "caml_call_gc" NEAR;
@@ -1378,8 +1434,8 @@ let begin_assembly ~init_dwarf =
   D.data ();
   emit_global_label "data_begin";
 
-  emit_named_text_section (Cmm_helpers.make_symbol "code_begin");
-  emit_global_label "code_begin";
+  emit_named_text_section code_begin;
+  emit_global_label_for_symbol code_begin;
   if system = S_macosx then I.nop (); (* PR#4690 *)
   ()
 
@@ -1677,7 +1733,7 @@ let emit_trap_notes () =
     D.data ()
   end
 
-let end_assembly dwarf =
+let end_assembly () =
   if !float_constants <> [] then begin
     begin match system with
     | S_macosx -> D.section ["__TEXT";"__literal8"] None ["8byte_literals"]
@@ -1692,11 +1748,12 @@ let end_assembly dwarf =
   (* Emit probe handler wrappers *)
   List.iter emit_probe_handler_wrapper !probes;
 
-  emit_named_text_section (Cmm_helpers.make_symbol "code_end");
+  let code_end = Cmm_helpers.make_symbol "code_end" in
+  emit_named_text_section code_end;
   if system = S_macosx then I.nop ();
   (* suppress "ld warning: atom sorting error" *)
 
-  emit_global_label "code_end";
+  emit_global_label_for_symbol code_end;
 
   emit_imp_table();
 
@@ -1769,6 +1826,6 @@ let end_assembly dwarf =
     else
       None
   in
-  Option.iter Dwarf_ocaml.Dwarf.emit dwarf;
+  Emitaux.Dwarf_helpers.emit_dwarf ();
   X86_proc.generate_code asm;
   reset_all ()

backend/arm64/emit.mlp

@@ -1151,7 +1151,10 @@ let fundecl fundecl =
   List.iter emit_call_bound_error !bound_error_sites;
   assert (List.length !call_gc_sites = num_call_gc);
   assert (List.length !bound_error_sites = num_check_bound);
-  `{emit_label fundecl.fun_end_label}:\n`;
+  (match Emitaux.Dwarf_helpers.record_dwarf_for_fundecl
+           ~fun_name:fundecl.fun_name fundecl.fun_dbg with
+   | None -> ()
+   | Some label -> `{emit_label label}:\n`);
   cfi_endproc();
   emit_symbol_type emit_symbol fundecl.fun_name "function";
   emit_symbol_size fundecl.fun_name;
@@ -1188,7 +1191,7 @@ let data l =
 
 (* Beginning / end of an assembly file *)
 
-let begin_assembly ~init_dwarf:_ =
+let begin_assembly _unix =
   reset_debug_info();
   `	.file	\"\"\n`;  (* PR#7037 *)
   let lbl_begin = Cmm_helpers.make_symbol "data_begin" in