.cms/.cmt dependency

Signed-off-by: Simon Spies <sspies@janestreet.com>

Author: spiessimon

src/dune_rules/compilation_context.ml

@@ -100,6 +100,7 @@ type t =
   ; modes : Lib_mode.Map.Set.t
   ; bin_annot : bool
   ; bin_annot_cms : bool
+  ; cms_cmt_dependency : Workspace.Context.Cms_cmt_dependency.t
   ; loc : Loc.t option
   ; ocaml : Ocaml_toolchain.t
   ; for_ : Compilation_mode.t
@@ -128,6 +129,7 @@ let implements t = t.implements
 let modes t = t.modes
 let bin_annot t = t.bin_annot
 let bin_annot_cms t = t.bin_annot_cms
+let cms_cmt_dependency t = t.cms_cmt_dependency
 let context t = Super_context.context t.super_context
 let dep_graphs t = t.modules.dep_graphs
 let ocaml t = t.ocaml
@@ -163,6 +165,7 @@ let create
       ?modes
       ?bin_annot
       ?bin_annot_cms
+      ?cms_cmt_dependency
       ?loc
       ?instances
       for_
@@ -216,6 +219,12 @@ let create
     match bin_annot_cms with
     | Some b -> Memo.return b
     | None -> Env_stanza_db.bin_annot_cms ~dir:(Obj_dir.dir obj_dir)
+  and+ cms_cmt_dependency =
+    match cms_cmt_dependency with
+    | Some v -> Memo.return v
+    | None ->
+      let context = Super_context.context super_context in
+      Memo.return (Context.cms_cmt_dependency context)
   in
   { super_context
   ; scope
@@ -238,6 +247,7 @@ let create
   ; modes
   ; bin_annot
   ; bin_annot_cms
+  ; cms_cmt_dependency
   ; loc
   ; ocaml
   ; instances
@@ -349,7 +359,13 @@ let for_plugin_executable t ~embed_in_plugin_libraries =
   { t with requires_link }
 ;;
 
-let without_bin_annot t = { t with bin_annot = false; bin_annot_cms = false }
+let without_bin_annot t =
+  { t with
+    bin_annot = false
+  ; bin_annot_cms = false
+  ; cms_cmt_dependency = Workspace.Context.Cms_cmt_dependency.No_dependency
+  }
+;;
 let set_obj_dir t obj_dir = { t with obj_dir }
 let set_modes t ~modes = { t with modes }
 let instances t = t.instances

src/dune_rules/compilation_context.mli

@@ -37,6 +37,7 @@ val create
   -> ?modes:Lib_mode.Map.Set.t
   -> ?bin_annot:bool
   -> ?bin_annot_cms:bool
+  -> ?cms_cmt_dependency:Workspace.Context.Cms_cmt_dependency.t
   -> ?loc:Loc.t
   -> ?instances:Parameterised_rules.instances list Resolve.Memo.t
   -> Compilation_mode.t
@@ -84,6 +85,7 @@ val for_module_generated_at_link_time
 val for_plugin_executable : t -> embed_in_plugin_libraries:(Loc.t * Lib_name.t) list -> t
 val bin_annot : t -> bool
 val bin_annot_cms : t -> bool
+val cms_cmt_dependency : t -> Workspace.Context.Cms_cmt_dependency.t
 val without_bin_annot : t -> t
 
 (** The dependency graph for the modules of the library. *)

src/dune_rules/context.ml

@@ -79,6 +79,7 @@ type builder =
   ; target_exec : (string * string list) option
   ; for_host : (Context_name.t * t Memo.t) option
   ; path : Path.t list
+  ; cms_cmt_dependency : Workspace.Context.Cms_cmt_dependency.t
   }
 
 and t =
@@ -118,6 +119,7 @@ module Builder = struct
     ; target_exec = None
     ; for_host = None
     ; path = []
+    ; cms_cmt_dependency = Workspace.Context.Cms_cmt_dependency.No_dependency
     }
   ;;
 
@@ -154,6 +156,7 @@ module Builder = struct
         ; dynamically_linked_foreign_archives
         ; instrument_with
         ; merlin
+        ; cms_cmt_dependency
         }
     =
     let env =
@@ -173,6 +176,7 @@ module Builder = struct
     ; env = Memo.return env
     ; findlib_toolchain = toolchain
     ; target_exec = None
+    ; cms_cmt_dependency
     }
   ;;
 end
@@ -199,6 +203,7 @@ let fdo_target_exe t = t.builder.fdo_target_exe
 let instrument_with t = t.builder.instrument_with
 let merlin t = t.builder.merlin
 let profile t = t.builder.profile
+let cms_cmt_dependency t = t.builder.cms_cmt_dependency
 let equal x y = Context_name.equal x.builder.name y.builder.name
 let hash t = Context_name.hash t.builder.name
 let build_context t = t.build_context

src/dune_rules/context.mli

@@ -51,6 +51,7 @@ val findlib_toolchain : t -> Context_name.t option
 val instrument_with : t -> Lib_name.t list
 val profile : t -> Profile.t
 val merlin : t -> bool
+val cms_cmt_dependency : t -> Workspace.Context.Cms_cmt_dependency.t
 val equal : t -> t -> bool
 val hash : t -> int
 val to_dyn : t -> Dyn.t

src/dune_rules/module_compilation.ml

@@ -30,19 +30,47 @@ let opens modules m =
   Command.Args.As (Modules.With_vlib.local_open modules m |> Ocaml_flags.open_flags)
 ;;
 
-let other_cm_files ~opaque ~cm_kind ~obj_dir =
+let other_cm_files ~opaque ~cm_kind ~obj_dir ~cms_cmt_dependency ~bin_annot ~bin_annot_cms
+      ~is_ox =
   List.concat_map ~f:(fun m ->
     let cmi_kind = Lib_mode.Cm_kind.cmi cm_kind in
     let deps = [ Path.build (Obj_dir.Module.cm_file_exn obj_dir m ~kind:cmi_kind) ] in
-    if Module.has m ~ml_kind:Impl && cm_kind = Ocaml Cmx && not opaque
-    then (
-      let cmx = Obj_dir.Module.cm_file_exn obj_dir m ~kind:(Ocaml Cmx) in
-      Path.build cmx :: deps)
-    else if Module.has m ~ml_kind:Impl && cm_kind = Melange Cmj
-    then (
-      let cmj = Obj_dir.Module.cm_file_exn obj_dir m ~kind:(Melange Cmj) in
-      Path.build cmj :: deps)
-    else deps)
+    let deps =
+      if Module.has m ~ml_kind:Impl && cm_kind = Ocaml Cmx && not opaque
+      then (
+        let cmx = Obj_dir.Module.cm_file_exn obj_dir m ~kind:(Ocaml Cmx) in
+        Path.build cmx :: deps)
+      else if Module.has m ~ml_kind:Impl && cm_kind = Melange Cmj
+      then (
+        let cmj = Obj_dir.Module.cm_file_exn obj_dir m ~kind:(Melange Cmj) in
+        Path.build cmj :: deps)
+      else deps
+    in
+    (* Add .cms/.cmt dependencies when enabled. Like .cmx dependencies, these are
+       skipped when -opaque is used. *)
+    let cms_cmt_deps =
+      let open Workspace.Context.Cms_cmt_dependency in
+      match cms_cmt_dependency with
+      | No_dependency -> []
+      | Depends_on_cms when bin_annot_cms && is_ox && not opaque ->
+        (* We pass as [cm_kind] [Ocaml Cmx/Cmi] but the specific [cm_kind]
+           doesn't matter here: .cms/.cmt files are stored in byte_dir
+           regardless (see [Obj_dir.Module.cms_file]). *)
+        List.filter_opt
+          [ Obj_dir.Module.cms_file obj_dir m ~ml_kind:Impl ~cm_kind:(Ocaml Cmx)
+          ; Obj_dir.Module.cms_file obj_dir m ~ml_kind:Intf ~cm_kind:(Ocaml Cmi)
+          ]
+        |> List.map ~f:Path.build
+      | Depends_on_cms -> []
+      | Depends_on_cmt when bin_annot && is_ox && not opaque ->
+        List.filter_opt
+          [ Obj_dir.Module.cmt_file obj_dir m ~ml_kind:Impl ~cm_kind:(Ocaml Cmx)
+          ; Obj_dir.Module.cmt_file obj_dir m ~ml_kind:Intf ~cm_kind:(Ocaml Cmi)
+          ]
+        |> List.map ~f:Path.build
+      | Depends_on_cmt -> []
+    in
+    cms_cmt_deps @ deps)
 ;;
 
 let copy_interface ~sctx ~dir ~obj_dir ~cm_kind m =
@@ -230,8 +258,21 @@ let build_cm
    let other_cm_files =
      let dep_graph = Ml_kind.Dict.get (Compilation_context.dep_graphs cctx) ml_kind in
      let module_deps = Dep_graph.deps_of dep_graph m in
+     let cms_cmt_dependency = Compilation_context.cms_cmt_dependency cctx in
+     let bin_annot = Compilation_context.bin_annot cctx in
+     let bin_annot_cms = Compilation_context.bin_annot_cms cctx in
+     let is_ox = Ocaml_config.ox ocaml.ocaml_config in
      Action_builder.dyn_paths_unit
-       (Action_builder.map module_deps ~f:(other_cm_files ~opaque ~cm_kind ~obj_dir))
+       (Action_builder.map module_deps
+          ~f:
+            (other_cm_files
+               ~opaque
+               ~cm_kind
+               ~obj_dir
+               ~cms_cmt_dependency
+               ~bin_annot
+               ~bin_annot_cms
+               ~is_ox))
    in
    let cmt_args =
      match cm_kind with

src/source/workspace.ml

@@ -382,6 +382,29 @@ module Context = struct
     ;;
   end
 
+  module Cms_cmt_dependency = struct
+    type t =
+      | No_dependency
+      | Depends_on_cms
+      | Depends_on_cmt
+
+    let equal x y =
+      match x, y with
+      | No_dependency, No_dependency
+      | Depends_on_cms, Depends_on_cms
+      | Depends_on_cmt, Depends_on_cmt -> true
+      | (No_dependency | Depends_on_cms | Depends_on_cmt), _ -> false
+    ;;
+
+    let to_dyn : t -> Dyn.t = function
+      | No_dependency -> String "none"
+      | Depends_on_cms -> String "cms"
+      | Depends_on_cmt -> String "cmt"
+    ;;
+
+    let decode = enum [ "none", No_dependency; "cms", Depends_on_cms; "cmt", Depends_on_cmt ]
+  end
+
   module Common = struct
     type t =
       { loc : Loc.t
@@ -396,6 +419,7 @@ module Context = struct
       ; dynamically_linked_foreign_archives : bool
       ; instrument_with : Lib_name.t list
       ; merlin : Merlin.t
+      ; cms_cmt_dependency : Cms_cmt_dependency.t
       }
 
     let to_dyn { name; targets; host_context; _ } =
@@ -419,6 +443,7 @@ module Context = struct
           ; dynamically_linked_foreign_archives
           ; instrument_with
           ; merlin
+          ; cms_cmt_dependency
           }
           t
       =
@@ -435,6 +460,7 @@ module Context = struct
            t.dynamically_linked_foreign_archives
       && List.equal Lib_name.equal instrument_with t.instrument_with
       && Merlin.equal merlin t.merlin
+      && Cms_cmt_dependency.equal cms_cmt_dependency t.cms_cmt_dependency
     ;;
 
     let fdo_suffix t =
@@ -505,6 +531,12 @@ module Context = struct
         field_b
           ~check:(Dune_lang.Syntax.since Stanza.syntax (3, 16))
           "generate_merlin_rules"
+      and+ cms_cmt_dependency =
+        field
+          "cms-cmt-dependency"
+          ~default:Cms_cmt_dependency.No_dependency
+          (Dune_lang.Syntax.since Dune_lang.Oxcaml.syntax (0, 1)
+           >>> Cms_cmt_dependency.decode)
       in
       fun ~profile_default ~instrument_with_default ->
         let profile = Option.value profile ~default:profile_default in
@@ -537,6 +569,7 @@ module Context = struct
                (match generate_merlin_rules with
                 | true -> Rules_only
                 | false -> Not_selected))
+        ; cms_cmt_dependency
         }
     ;;
   end
@@ -708,6 +741,7 @@ module Context = struct
           ; dynamically_linked_foreign_archives = true
           ; instrument_with = Option.value instrument_with ~default:[]
           ; merlin = Not_selected
+          ; cms_cmt_dependency = Cms_cmt_dependency.No_dependency
           }
       }
   ;;

src/source/workspace.mli

@@ -60,6 +60,16 @@ module Context : sig
     val to_dyn : t -> Dyn.t
   end
 
+  module Cms_cmt_dependency : sig
+    type t =
+      | No_dependency
+      | Depends_on_cms
+      | Depends_on_cmt
+
+    val equal : t -> t -> bool
+    val to_dyn : t -> Dyn.t
+  end
+
   module Common : sig
     type t =
       { loc : Loc.t
@@ -80,6 +90,7 @@ module Context : sig
       ; dynamically_linked_foreign_archives : bool
       ; instrument_with : Lib_name.t list
       ; merlin : Merlin.t
+      ; cms_cmt_dependency : Cms_cmt_dependency.t
       }
   end