Merge changes from ocaml/ocaml#13308

[tooling] Remember linked declarations

Author: voodoos

Changes

@@ -665,6 +665,11 @@ OCaml 5.2.0
   provenance: either an implementation or an interface.
   (Ulysse Gérard, review by Florian Angeletti and Leo White)
 
+- #13308: keep track of relations between declaration in the cmt files. This is
+  useful information for external tools for navigation and analysis purposis.
+  (Ulysse Gérard, Florian Angeletti, review by Florian Angeletti and Gabriel
+  Scherer)
+
 ### Build system:
 
 - #12198, #12321, #12586, #12616, #12706, #13048: continue the merge of the

driver/compile_common.ml

@@ -85,7 +85,7 @@ let typecheck_intf info ast =
         Format.(fprintf std_formatter) "%a@."
           (Printtyp.printed_signature (Unit_info.source_file info.target))
           sg);
-  ignore (Includemod.signatures info.env ~mark:Mark_both
+  ignore (Includemod.signatures info.env ~mark:true
     ~modes:(Legacy None) sg sg);
   Typecore.force_delayed_checks ();
   Builtin_attributes.warn_unused ();

file_formats/cmt_format.ml

@@ -45,11 +45,11 @@ and binary_part =
   | Partial_signature_item of signature_item
   | Partial_module_type of module_type
 
+type dependency_kind =  Definition_to_declaration | Declaration_to_declaration
 type cmt_infos = {
   cmt_modname : Compilation_unit.t;
   cmt_annots : binary_annots;
-  cmt_value_dependencies :
-    (Types.value_description * Types.value_description) list;
+  cmt_declaration_dependencies : (dependency_kind * Uid.t * Uid.t) list;
   cmt_comments : (string * Location.t) list;
   cmt_args : string array;
   cmt_sourcefile : string option;
@@ -452,19 +452,19 @@ let read_cmi filename =
     | Some cmi, _ -> cmi
 
 let saved_types = ref []
-let value_deps = ref []
+let uids_deps : (dependency_kind * Uid.t * Uid.t) list ref = ref []
 
 let clear () =
   saved_types := [];
-  value_deps := []
+  uids_deps := []
 
 let add_saved_type b = saved_types := b :: !saved_types
 let get_saved_types () = !saved_types
 let set_saved_types l = saved_types := l
 
-let record_value_dependency vd1 vd2 =
-  if vd1.Types.val_loc <> vd2.Types.val_loc then
-    value_deps := (vd1, vd2) :: !value_deps
+let record_declaration_dependency (rk, uid1, uid2) =
+  if not (Uid.equal uid1 uid2) then
+    uids_deps := (rk, uid1, uid2) :: !uids_deps
 
 let save_cmt target cu binary_annots initial_env cmi shape =
   if !Clflags.binary_annotations && not !Clflags.print_types then begin
@@ -499,7 +499,7 @@ let save_cmt target cu binary_annots initial_env cmi shape =
          let cmt = {
            cmt_modname = cu;
            cmt_annots;
-           cmt_value_dependencies = !value_deps;
+           cmt_declaration_dependencies = !uids_deps;
            cmt_comments = Lexer.comments ();
            cmt_args = Sys.argv;
            cmt_sourcefile = sourcefile;

file_formats/cmt_format.mli

@@ -48,11 +48,11 @@ and binary_part =
   | Partial_signature_item of signature_item
   | Partial_module_type of module_type
 
+type dependency_kind = Definition_to_declaration | Declaration_to_declaration
 type cmt_infos = {
   cmt_modname : Compilation_unit.t;
   cmt_annots : binary_annots;
-  cmt_value_dependencies :
-    (Types.value_description * Types.value_description) list;
+  cmt_declaration_dependencies : (dependency_kind * Uid.t * Uid.t) list;
   cmt_comments : (string * Location.t) list;
   cmt_args : string array;
   cmt_sourcefile : string option;
@@ -108,8 +108,7 @@ val add_saved_type : binary_part -> unit
 val get_saved_types : unit -> binary_part list
 val set_saved_types : binary_part list -> unit
 
-val record_value_dependency:
-  Types.value_description -> Types.value_description -> unit
+val record_declaration_dependency: dependency_kind * Uid.t * Uid.t -> unit
 
 val index_occurrences :
   binary_annots -> (Longident.t Location.loc * Shape_reduce.result) array

testsuite/tests/uid-deps/link_intf_impl.ml

@@ -0,0 +1,59 @@
+(* TEST
+
+flags = "-bin-annot -bin-annot-occurrences";
+compile_only = "true";
+setup-ocamlc.byte-build-env;
+all_modules = "link_intf_impl.mli link_intf_impl.ml";
+ocamlc.byte;
+check-ocamlc.byte-output;
+
+program = "-quiet -uid-deps link_intf_impl.cmt";
+output = "out_objinfo";
+ocamlobjinfo;
+
+check-program-output;
+*)
+
+let x (* 0 *) = 42
+
+type t (* 1 *) = int
+
+module type S (* 3 *) = sig
+  val y (* 2 *) : t
+end
+
+module M (* 5 *) : S = struct
+  let y (* 4 *) = 36
+end
+
+module N (* 8 *) : sig
+  val y (* 7 *) : int
+end = struct
+  let y (* 6 *) = 2
+end
+
+let _ = (module N : S)
+
+module P (* 10 *)= struct
+  let y (* 9 *) = 12
+end
+
+module F (* 12 *) (X (* 11 *) : S) = X
+
+module G (* 13 *) = F(P)
+
+module type Initial (* 16 *) = sig
+  module type Nested (* 15 *) = sig
+    type t (* 14 *)
+  end
+end
+
+module MF (* 23 *) : sig
+   module F (* 22 *) (X (* 21 *) : sig val x (* 20 *) : int end) : sig end
+end = struct
+  module F (* 19 *) (X (* 18 *) : sig val x (* 17 *) : int end) = struct end
+end
+
+module FMT (* 27 *) (X (* 26 *) : sig
+  module type MT (* 25 *) = sig val x (* 24 *) : int end
+end) : sig end = struct end

testsuite/tests/uid-deps/link_intf_impl.mli

@@ -0,0 +1,19 @@
+type t (* 0 *)
+
+val x (* 1 *) : t
+
+module type S (* 3 *) = sig
+  val y (* 2 *) : t
+end
+
+module M (* 4 *) : S
+
+module type Initial (* 7 *) = sig
+  module type Nested (* 6 *) = sig
+    type t (* 5 *)
+  end
+end
+
+module FMT (* 11 *) (X (* 10 *) : sig
+  module type MT (* 9 *) = sig val x (* 8 *) : int end
+end) : sig end

testsuite/tests/uid-deps/link_intf_impl.reference

@@ -0,0 +1,19 @@
+
+Uid dependencies:
+Link_intf_impl.0 <- [intf]Link_intf_impl.1
+Link_intf_impl.1 <- [intf]Link_intf_impl.0
+Link_intf_impl.2 <-> [intf]Link_intf_impl.2
+Link_intf_impl.3 <- [intf]Link_intf_impl.3
+Link_intf_impl.4 <- Link_intf_impl.2
+Link_intf_impl.5 <- [intf]Link_intf_impl.4
+Link_intf_impl.6 <- Link_intf_impl.7
+Link_intf_impl.7 <-> Link_intf_impl.2
+Link_intf_impl.9 <-> Link_intf_impl.2
+Link_intf_impl.14 <-> [intf]Link_intf_impl.5
+Link_intf_impl.15 <-> [intf]Link_intf_impl.6
+Link_intf_impl.16 <- [intf]Link_intf_impl.7
+Link_intf_impl.17 <-> Link_intf_impl.20
+Link_intf_impl.19 <- Link_intf_impl.22
+Link_intf_impl.24 <-> [intf]Link_intf_impl.8
+Link_intf_impl.25 <-> [intf]Link_intf_impl.9
+Link_intf_impl.27 <- [intf]Link_intf_impl.11

tools/objinfo.ml

@@ -39,6 +39,7 @@ let no_crc = ref false
 let shape = ref false
 let index = ref false
 let decls = ref false
+let uid_deps = ref false
 
 module Magic_number = Misc.Magic_number
 module String = Misc.Stdlib.String
@@ -213,6 +214,27 @@ let print_cmt_infos cmt =
       cmt.cmt_ident_occurrences;
     Format.print_flush ()
   end;
+  if !uid_deps then begin
+    printf "\nUid dependencies:\n";
+    let arr = Array.of_list cmt.cmt_declaration_dependencies in
+    let () =
+      Array.sort (fun (_tr, u1, u2) (_tr', u1', u2') ->
+                    match Shape.Uid.compare u1 u1' with
+                    | 0 -> Shape.Uid.compare u2 u2'
+                    | n -> n) arr
+    in
+    Format.printf "@[<v>";
+    Array.iter (fun (rk, u1, u2) ->
+      let rk = match rk with
+        | Definition_to_declaration -> "<-"
+        | Declaration_to_declaration -> "<->"
+      in
+      Format.printf "@[<h>%a %s %a@]@;"
+        Shape.Uid.print u1
+        rk
+        Shape.Uid.print u2) arr;
+    Format.printf "@]";
+  end;
   if !decls then begin
     printf "\nUid of decls:\n";
     let decls = Array.of_list (Shape.Uid.Tbl.to_list cmt.cmt_uid_to_decl) in
@@ -571,6 +593,8 @@ let arg_list = [
     " Print a list of all usages of values, types, etc. in the module";
   "-decls", Arg.Set decls,
     " Print a list of all declarations in the module";
+  "-uid-deps", Arg.Set uid_deps,
+    " Print the declarations' uids dependencies of the module";
   "-null-crc", Arg.Set no_crc, " Print a null CRC for imported interfaces";
   "-args", Arg.Expand Arg.read_arg,
      "<file> Read additional newline separated command line arguments \n\

toplevel/byte/topeval.ml

@@ -125,8 +125,7 @@ let execute_phrase print_outcome ppf phr =
       in
       if !Clflags.dump_typedtree then Printtyped.implementation ppf str;
       let sg' = Typemod.Signature_names.simplify newenv sn sg in
-      ignore (Includemod.signatures ~mark:Mark_positive oldenv
-        ~modes:(Legacy None) sg sg');
+      Includemod.check_implementation oldenv ~modes:(Legacy None) sg sg';
       Typecore.force_delayed_checks ();
       let shape = Shape_reduce.local_reduce Env.empty shape in
       if !Clflags.dump_shape then Shape.print ppf shape;

toplevel/native/opttoploop.ml

@@ -401,7 +401,7 @@ let execute_phrase print_outcome ppf phr =
       if !Clflags.dump_typedtree then Printtyped.implementation ppf str;
       let sg' = Typemod.Signature_names.simplify newenv names sg in
       let coercion =
-        Includemod.signatures oldenv ~mark:Mark_positive
+        Includemod.signatures oldenv ~mark:true
           ~modes:(Legacy None) sg sg'
       in
       Typecore.force_delayed_checks ();

toplevel/native/topeval.ml

@@ -185,7 +185,7 @@ let execute_phrase print_outcome ppf phr =
       in
       if !Clflags.dump_typedtree then Printtyped.implementation ppf str;
       let sg' = Typemod.Signature_names.simplify newenv names sg in
-      ignore (Includemod.signatures oldenv ~mark:Mark_positive sg sg');
+      Includemod.check_implementation oldenv ~modes:(Legacy None) sg sg';
       Typecore.force_delayed_checks ();
       let shape = Shape_reduce.local_reduce Env.empty shape in
       if !Clflags.dump_shape then Shape.print ppf shape;